Add python client docs to docs/, run in CI #2
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
|
This PR exists primarily for early review; it will be rebased against master once armadaproject#1084 merges. |
jayofdoom
force-pushed
the
client_doc_generation_pt2
branch
from
66236b9 to
8fe552a
Compare
- 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.
kannon92
reviewed
Jun 16, 2022
kannon92
reviewed
Jun 16, 2022
| ## Python | ||
| Armada provides python client bindings providing access to the RPC API. | ||
|
|
||
| ### Installation |
There was a problem hiding this comment.
We have a readme for the python client library. Maybe link to it?
kannon92
reviewed
Jun 16, 2022
jayofdoom
force-pushed
the
client_doc_generation_pt2
branch
from
8fe552a to
bc32eb4
Compare
- Adds a tox target, which runs in CI, which only passes if the generated version of the python armada client docs are the same as the version committed. - Adds a new top level page to armadaproject.io (will be added to menu in separate PR once this merges) containing basic information about libraries provided for armada usage. This will be improved significantly over time as we develop examples for our clients and generally make them more friendly. - Initial commit of generated python armada client docs. This is part 2 of issue armadaproject#1027
jayofdoom
force-pushed
the
client_doc_generation_pt2
branch
from
bc32eb4 to
0f89989
Compare
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.
generated version of the python armada client docs are the same
as the version committed.
menu in separate PR once this merges) containing basic
information about libraries provided for armada usage. This will
be improved significantly over time as we develop examples for
our clients and generally make them more friendly.
This is part 2 of issue armadaproject#1027.