Skip to content

Commit d8d3ef5

Browse files
authored
Specify YARD Markdown provider (googleapis#2232)
All gems use Markdown syntax for documentation, and we have configured YARD to generate documentation accordingly. However, we also use some Markdown options, such as fenced code blocks, that are not standard Markdown and not supported in all Markdown providers. Set the Markdown provider to redcarpet to ensure that documentation generates properly. * Specify redcarpet in the .yardopts file. * Add redcarpet as a development dependency. This will ensure that users who generate documentation from the gem will produce properly formatted documentation. * Add YARD as a development dependency to gems that were missing it.
1 parent fa3b2ca commit d8d3ef5

70 files changed

Lines changed: 83 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ gem "minitest-autotest", "~> 1.0"
66
gem "minitest-focus", "~> 1.1"
77
gem "minitest-rg", "~> 5.2"
88
gem "autotest-suffix", "~> 1.1"
9+
gem "redcarpet", "~> 3.0"
910
gem "rubocop", "~> 0.50.0"
1011
gem "simplecov", "~> 0.9"
1112
gem "coveralls", "~> 0.7"

gcloud/.yardopts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
--no-private
22
--title=Gcloud
33
--markup markdown
4+
--markup-provider redcarpet
45

56
./lib/**/*.rb
67
-

gcloud/gcloud.gemspec

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Gem::Specification.new do |gem|
2525
gem.add_development_dependency "minitest-focus", "~> 1.1"
2626
gem.add_development_dependency "minitest-rg", "~> 5.2"
2727
gem.add_development_dependency "autotest-suffix", "~> 1.1"
28+
gem.add_development_dependency "redcarpet", "~> 3.0"
2829
gem.add_development_dependency "rubocop", "~> 0.50.0"
2930
gem.add_development_dependency "simplecov", "~> 0.9"
3031
gem.add_development_dependency "yard", "~> 0.9"

google-cloud-bigquery-data_transfer/.yardopts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
--title=BigQuery Data Transfer API
33
--exclude _pb\.rb$
44
--markup markdown
5+
--markup-provider redcarpet
56

67
./lib/**/*.rb
78
-

google-cloud-bigquery-data_transfer/google-cloud-bigquery-data_transfer.gemspec

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Gem::Specification.new do |gem|
2323
gem.add_dependency "google-gax", "~> 1.3"
2424

2525
gem.add_development_dependency "minitest", "~> 5.10"
26+
gem.add_development_dependency "redcarpet", "~> 3.0"
2627
gem.add_development_dependency "rubocop", "~> 0.50.0"
2728
gem.add_development_dependency "simplecov", "~> 0.9"
29+
gem.add_development_dependency "yard", "~> 0.9"
2830
end

google-cloud-bigquery/.yardopts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
--no-private
22
--title=Google Cloud BigQuery
33
--markup markdown
4+
--markup-provider redcarpet
45

56
./lib/**/*.rb
67
-

google-cloud-bigquery/google-cloud-bigquery.gemspec

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Gem::Specification.new do |gem|
2828
gem.add_development_dependency "minitest-focus", "~> 1.1"
2929
gem.add_development_dependency "minitest-rg", "~> 5.2"
3030
gem.add_development_dependency "autotest-suffix", "~> 1.1"
31+
gem.add_development_dependency "redcarpet", "~> 3.0"
3132
gem.add_development_dependency "rubocop", "~> 0.50.0"
3233
gem.add_development_dependency "simplecov", "~> 0.9"
3334
gem.add_development_dependency "yard", "~> 0.9"

google-cloud-bigtable/.yardopts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
--title=Cloud Bigtable API
33
--exclude _pb\.rb$
44
--markup markdown
5+
--markup-provider redcarpet
56
--embed-mixins
67

78
./lib/**/*.rb

google-cloud-bigtable/google-cloud-bigtable.gemspec

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Gem::Specification.new do |gem|
2727
gem.add_development_dependency "minitest", "~> 5.10"
2828
gem.add_development_dependency "minitest-focus", "~> 1.1"
2929
gem.add_development_dependency "minitest-rg", "~> 5.2"
30+
gem.add_development_dependency "redcarpet", "~> 3.0"
3031
gem.add_development_dependency "rubocop", "~> 0.50.0"
3132
gem.add_development_dependency "simplecov", "~> 0.9"
3233
gem.add_development_dependency "yard", "~> 0.9"

google-cloud-container/.yardopts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
--title=Google Container Engine API
33
--exclude _pb\.rb$
44
--markup markdown
5+
--markup-provider redcarpet
56

67
./lib/**/*.rb
78
-

0 commit comments

Comments
 (0)