Add readthedocs support #399
Open
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
|
(We can hang fire on this until the docs are in a better state) |
|
This looks good. Can we squash it down to one commit and then i'll merge it? |
wllgrnt
force-pushed
the
will_grant/add_markdown_RTD_support
branch
from
d1fc3a3 to
c4165cb
Compare
Config code will regenerate the docs from the docstrings every rebuild. Also excludes tests from the generated html. Docs will be available at typed-python.readthedocs.io.
wllgrnt
force-pushed
the
will_grant/add_markdown_RTD_support
branch
from
c4165cb to
538affa
Compare
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.
Motivation and Context
Once merged, this will allow the Sphinx docs in docs/ (and the docstrings) to be built and served at typed-python.readthedocs.io. With an appropriate webhook the docs would be rebuilt automatically with every commit to
devbut that's a separate discussion.Apologies for the many commits - the RTD/sphinx-apidoc documentation is sparse, and learning which shells RTD and Make like to use, and which of those support the globstar operator, was non-trivial.
How Has This Been Tested?
This branch's docs are viewable at https://typed-python.readthedocs.io/en/will_grant-add_markdown_rtd_support/. Will delete once merged.
Types of changes
Checklist: