doc api reference #79
Merged
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
najohnsn
force-pushed
the
ref-doc
branch
7 times, most recently
from
7de656b
to
5a7c25c
Compare
Signed-off-by: Neil Johnson <[email protected]>
Merged
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.
This PR generates reference documentation from the source code.
As part of this, the requirement specification is improved - by putting all dependencies in
requirements.txtand being more specific about versions. However, this was problematic for some of requirements for documentation generation - tools are only available on Python 3.8 and higher. Since the document generation is only needed in environments that use Python 3.8 or higher, a version constraint was put on those requirements.A few changes were made to docstrings in order to get the documentation generation to look nicer. Clearly, a lot more is needed though. I expect this do be done over time in the future.