-
Notifications
You must be signed in to change notification settings - Fork 7
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
Fix #429 readthedocs build #436
Closed
Closed
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
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.
Updates pykern to conform to the new readthedocs process:
.readthdocs.yml
with required settings (and see below)docs/requirements.txt
and excepting it fromdocs/.gitignore
setup()
and writesdocs/conf.py
These are the commands that readthedocs runs to build documents:
In our case the only thing in
docs/requirements.txt
is ".", meaning install pykern itself including its requirements as listed insetup.py._requires()
, and the only pre-build command ispython setup.py readthedocs
to call the new command class.Another note: we still need sphinx-apidoc to generate the .rst files. It's actually available on readthedocs but we'll do it in the command class so we have control over the packages.
YAN:
python setup.py tox
fails even in master. It's not related to this issue so I did not address it.YAN: We may be able to ditch
_readthedocs_fixup()
but I'm not sure...