This repository was archived by the owner on Jan 18, 2025. It is now read-only.
Making tweaks to allow project to build on readthedocs.org.#237
Merged
dhermes merged 1 commit intogoogleapis:masterfrom Aug 7, 2015
Merged
Making tweaks to allow project to build on readthedocs.org.#237dhermes merged 1 commit intogoogleapis:masterfrom
dhermes merged 1 commit intogoogleapis:masterfrom
Conversation
Contributor
Author
|
@nathanielmanistaatgoogle Anything holding back a review here? |
docs/requirements.txt
Outdated
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.
Contributor
|
Thanks for the poke. |
dhermes
force-pushed
the
read-the-docs-build-helpers
branch
from
9f553e4 to
f166fdb
Compare
In particular - Adding a requirements.txt file to aid in installing docs-only dependencies (this is a feature of readthedocs, see https://docs.readthedocs.org/en/latest/builds.html) - Updating comment before `import django` in docs/conf.py. Without the setup that or tox `docs` env provides or the dependencies in docs/requirements.txt, sphinx-build will fail due to missing `django` - Adding a section to docs/conf.py which downloads the App Engine SDK and adds it to the import path - Adding base (non-docs) dir so sources get added when generating HTML (e.g. sys.path.append('..') within docs/ dir) - Using package distribution for docs version instead of manually importing oauth2client in docs/conf.py.
dhermes
force-pushed
the
read-the-docs-build-helpers
branch
from
f166fdb to
a39aa25
Compare
Contributor
Author
|
@nathanielmanistaatgoogle Change (from |
Contributor
|
LGTM and waiting on test results (which I believe will be forthcoming...). |
Contributor
Author
|
Looks like the |
dhermes
added a commit
that referenced
this pull request
Aug 7, 2015
Making tweaks to allow project to build on readthedocs.org.
Contributor
Author
|
Succeeded on rebuild. |
Merged
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
In particular
dependencies (this is a feature of readthedocs, see
https://docs.readthedocs.org/en/latest/builds.html)
import djangoin docs/conf.py. Withoutthe setup that or tox
docsenv provides or the dependenciesin docs/requirements.txt, sphinx-build will fail due to missing
djangoApp Engine SDK and adds it to the import path
HTML (e.g. sys.path.append('..') within docs/ dir)
importing oauth2client in docs/conf.py.
@nathanielmanistaatgoogle See http://oauth2client.readthedocs.org/en/rtd-test/ for a final view of what this looks like (and compare it to http://google.github.io/oauth2client/)