Generate reference docs #14
Open
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
libutcher
reviewed
Apr 5, 2024
|
|
||
| v0.1.0 | ||
|
|
||
| ## Client Objects |
There was a problem hiding this comment.
Are we able to edit the doc generator so these headers are sentence cased? For example: "Client objects"
| @@ -0,0 +1,35 @@ | |||
| --- | |||
| sidebar_label: client | |||
There was a problem hiding this comment.
It looks like this metadata is appearing on the front end as a table. Is there a way to avoid that?
| class Client() | ||
| ``` | ||
|
|
||
| A client |
There was a problem hiding this comment.
This doesn't look correct. I'm not sure where it's being source from.
There was a problem hiding this comment.
It's sourced from a comment from client.py. It can be edited there, in place
There was a problem hiding this comment.
That's strange - I don't see "A client" in that file. Could you point me to it in case I'm missing something?
There was a problem hiding this comment.
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 adds automatically generated reference docs.
The documentation is generated via the pydoc-markdown CLI.
How to test
Install
pydoc-markdown:pip install pydoc-markdownRun the generation script:
./scripts/generate_docs.sh