Commit d8d3ef5
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
- gcloud
- google-cloud-bigquery-data_transfer
- google-cloud-bigquery
- google-cloud-bigtable
- google-cloud-container
- google-cloud-core
- google-cloud-dataproc
- google-cloud-datastore
- google-cloud-debugger
- google-cloud-dialogflow
- google-cloud-dlp
- google-cloud-dns
- google-cloud-env
- google-cloud-error_reporting
- google-cloud-firestore
- google-cloud-kms
- google-cloud-language
- google-cloud-logging
- google-cloud-monitoring
- google-cloud-os_login
- google-cloud-pubsub
- google-cloud-redis
- google-cloud-resource_manager
- google-cloud-spanner
- google-cloud-speech
- google-cloud-storage
- google-cloud-tasks
- google-cloud-text_to_speech
- google-cloud-trace
- google-cloud-translate
- google-cloud-video_intelligence
- google-cloud-vision
- google-cloud
- stackdriver-core
- stackdriver
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| 9 | + | |
9 | 10 | | |
10 | 11 | | |
11 | 12 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
| 28 | + | |
28 | 29 | | |
29 | 30 | | |
30 | 31 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| 5 | + | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
| |||
Lines changed: 2 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| 26 | + | |
26 | 27 | | |
27 | 28 | | |
| 29 | + | |
28 | 30 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
| 31 | + | |
31 | 32 | | |
32 | 33 | | |
33 | 34 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| 5 | + | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| 30 | + | |
30 | 31 | | |
31 | 32 | | |
32 | 33 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| 5 | + | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
| |||
0 commit comments