Add docs session to nox configuration for BigQuery#7541
Merged
tswast merged 2 commits intogoogleapis:masterfrom Mar 22, 2019
Merged
Add docs session to nox configuration for BigQuery#7541tswast merged 2 commits intogoogleapis:masterfrom
tswast merged 2 commits intogoogleapis:masterfrom
Conversation
* 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.
Contributor
Author
|
Test failure appears to be a flake. All sessions passed except |
busunkim96
reviewed
Mar 22, 2019
This file contains hidden or 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
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.
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.