-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs session to nox configuration for BigQuery #7541
Merged
Merged
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
* Run with `nox -s docs`. This allows us to just build the BigQuery docs to preview changes more quickly. * Moves the magics module documentation to the top level. I found it impossible to debug the autosummary errors with generating the docs for the magics module, so I move those docs to our more standard automodule pattern. With automodule, the error messages were more clear (the IPython package was missing in my original implementation). Since this module is referenced in documentation and elsewhere, add a redirect to the new magics module documentation from the old generated location.
googlebot
added
the
cla: yes
This human has signed the Contributor License Agreement.
label
Mar 21, 2019
tswast
added
api: bigquery
Issues related to the BigQuery API.
type: docs
Improvement to the documentation for an API.
labels
Mar 21, 2019
Test failure appears to be a flake. All sessions passed except
|
tswast
added
the
kokoro:force-run
Add this label to force Kokoro to re-run the tests.
label
Mar 21, 2019
yoshi-kokoro
removed
the
kokoro:force-run
Add this label to force Kokoro to re-run the tests.
label
Mar 21, 2019
busunkim96
reviewed
Mar 22, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
api: bigquery
Issues related to the BigQuery API.
cla: yes
This human has signed the Contributor License Agreement.
type: docs
Improvement to the documentation for an API.
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.
Run with
nox -s docs
. This allows us to just build the BigQuery docsto preview changes more quickly.
Moves the magics module documentation to the top level. I found it
impossible to debug the autosummary errors with generating the docs
for the magics module, so I move those docs to our more standard
automodule pattern. With automodule, the error messages were more
clear (the IPython package was missing in my original implementation).
Since this module is referenced in documentation and elsewhere, add a
redirect to the new magics module documentation from the old generated
location.