Setup of documentation, to be generated with sphinx #34
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.
Made new pull request about start of documentation. This time the pull request start from upstream master and commits only files related to documentation
To generate the documentation you need to run
pip install sphinx sphinx-autodoc-typehints sphinx-rtd-theme
sphinx-build -b html docs docs/_build
I did not commit the actual documentation. You can find attached it to this pull request _build.zip
I only create a doc file for the main module, and I had to fix the docstrings to accomodate it. Please tell me if you like the structure and if you want docs for all modules or you think it's not needed