Sphinx docs #464
Merged
Sphinx docs #464
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
achow101
force-pushed
the
sphinx-docs
branch
from
470f507
to
0aa70d0
Compare
Some changes to hwilib/cli.py is needed to automatically populate the docs with the usage text
achow101
force-pushed
the
sphinx-docs
branch
from
0aa70d0
to
4b5792a
Compare
|
Didn't read the entire diff (checking the conversion from md to rst in detail) but concept ACK, this would be useful. |
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.
Adds documentation that can be generated using sphinx. The documentation is moved almost entirely to docstrings for each function and class. Additionally all of our existing documentation is reformatted to use sphinx's rst format.
Once this is merged, I will enable automatic generation on readthedocs.org for this repo.