Add API docs using Sphinx#59
Open
michaeldickens wants to merge 7 commits intorethinkpriorities:mainfrom
Open
Conversation
Contributor
Author
|
I forgot, I need to update Poetry to add a dependency for pydata_sphinx_theme Edit: fixed |
Contributor
Author
|
I am not sure whether the doc/build/ directory should be tracked, I noticed that scipy does track their doc/build/ but it contains binaries and stuff that git doesn't deal with well. |
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 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.
Implementation of issue #44.
Changes:
sphinx-apidocto auto-generate API docs for all modules in docs/source/reference/.To build docs:
To view docs, open docs/build/html/index.html in your browser.
(Note: Makefile was generated by Sphinx, but I added the
make buildapibased on this StackOverflow answer.)