docs: update python docs template #576
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
googlebot
added
the
cla: yes
|
@crwilcox PTAL |
| @@ -166,7 +166,7 @@ def docs(session): | |||
| """Build the docs for this library.""" | |||
|
|
|||
| session.install('-e', '.') | |||
| session.install('sphinx<3.0.0', 'alabaster', 'recommonmark') | |||
| session.install('sphinx', 'alabaster', 'recommonmark') | |||
There was a problem hiding this comment.
@crwilcox IIRC, you needed a specific version of sphinx. Will this break you?
There was a problem hiding this comment.
We made this change here: googleapis/python-bigtable#20 and the docs build passed successfully, so we wanted to make this change more broadly.
frankyn
approved these changes
May 21, 2020
| @@ -38,6 +38,7 @@ extensions = [ | |||
| "sphinx.ext.napoleon", | |||
| "sphinx.ext.todo", | |||
| "sphinx.ext.viewcode", | |||
| "recommonmark", | |||
There was a problem hiding this comment.
We did the same change in python-storage: googleapis/python-storage#103
Didn't realize it came from this parent template. The rationale for it:
https://github.com/readthedocs/recommonmark
# for Sphinx-1.4 or newer
extensions = ['recommonmark'] # <---- this
# for Sphinx-1.3
from recommonmark.parser import CommonMarkParser
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
SurferJeffAtGoogle
approved these changes
May 26, 2020
|
@SurferJeffAtGoogle do you mind merging this? I don't have access :) |
busunkim96
approved these changes
May 28, 2020
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.
Fixes #570