Python client: Improve docstrings, generate docs #1084
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
jayofdoom
force-pushed
the
client_doc_generation
branch
2 times, most recently
from
d66d6ab
to
edc2ddb
Compare
jayofdoom
force-pushed
the
client_doc_generation
branch
2 times, most recently
from
4fe936f
to
d601845
Compare
kannon92
previously approved these changes
Jun 15, 2022
- Improves docstrings and makes them compliant with RST format expected by sphinx. - Adds configuration and automation for generating jekyll-markdown files from docstrings (for use with gh-pages) - Adds documenation on how to use the generation. The docstrings in the code can still use significant improvement as our understanding of the API and python types involved improve, however this is better than what we have today and provides a basis for future improvement. First half of changes needed for armadaproject#1027.
jayofdoom
force-pushed
the
client_doc_generation
branch
from
d601845
to
22b0577
Compare
kannon92
approved these changes
Jun 15, 2022
severinson
approved these changes
Jun 16, 2022
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.
expected by sphinx.
files from docstrings (for use with gh-pages)
The docstrings in the code can still use significant improvement
as our understanding of the API and python types involved improve,
however this is better than what we have today and provides a basis
for future improvement.
First half of changes needed for #1027.