docs: clean up docs and let the nox pass #24
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
product-auto-label
bot
added
the
api: bigquery
|
Here is the summary of changes. You are about to delete 57 region tags.
This comment is generated by snippet-bot.
|
product-auto-label
bot
added
size: l
tswast
requested changes
Apr 22, 2024
docs/index.rst
Outdated
| usage/index | ||
| Official Google BigQuery How-to Guides <https://cloud.google.com/bigquery/docs/how-to> | ||
| magics | ||
| Official Google BigQuery Magics Guide <https://cloud.google.com/python/docs/reference/bigquery/latest/magics> |
There was a problem hiding this comment.
This page is going to change. Likely we'll want to publish sphinx docs to googleapis.dev similar to https://googleapis.dev/python/pandas-gbq/latest/
That said, if you're looking for an equivalent to the usage guides, that's not it anyway.
https://cloud.google.com/bigquery/docs/visualize-jupyter is close, though that's a tutorial, not a usage guide.
There was a problem hiding this comment.
ACK, putting https://cloud.google.com/bigquery/docs/visualize-jupyter link for interim now until we have the sphinx docs ready.
| @@ -15,14 +15,14 @@ Code Samples | |||
|
|
|||
| Running a query: | |||
|
|
|||
| .. literalinclude:: ./samples/snippets/query.py | |||
| .. literalinclude:: ../samples/snippets/query.py | |||
There was a problem hiding this comment.
Does this actually work? In the past, I've had to put a symlink in the docs folder to the samples for the docs build to actually find the right files.
There was a problem hiding this comment.
Yes, it works. Otherwise, I can't pass the nox -s docs
tswast
reviewed
Apr 25, 2024
There was a problem hiding this comment.
We can delete this file. Probably in the next PR though, since it'll be nice just to have the docs build passing.
tswast
approved these changes
Apr 25, 2024
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.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #10 🦕