BigQuery: use autosummary to split up API reference docs #5340
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
googlebot
added
the
cla: yes
tseaver
reviewed
May 17, 2018
docs/bigquery/reference.rst
Outdated
| job.ExtractJob | ||
| job.UnknownJob | ||
|
|
||
| Job Resources |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
| @@ -0,0 +1,280 @@ | |||
| License for Sphinx | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
|
|
||
| .. currentmodule:: {{ module }} | ||
|
|
||
| .. autoclass:: {{ objname }} |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
| @@ -603,7 +603,7 @@ def get_job( | |||
| Returns: | |||
| Union[google.cloud.bigquery.job.LoadJob, \ | |||
| google.cloud.bigquery.job.CopyJob, \ | |||
| google.cloud.bigquery.job.ExtractJob \ | |||
| google.cloud.bigquery.job.ExtractJob, \ | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
crwilcox
approved these changes
May 22, 2018
This was referenced May 22, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@alixhami and I have heard from several folks that the BigQuery API Reference docs are pretty impossible to navigate. This PR uses the autosummary module to split the docs into separate pages with an easier to browse summary table.