Conversation
libutcher
left a comment
libutcher
left a comment
There was a problem hiding this comment.
Left some questions! Looking at this, I think the comments also need another pass to make sure they're edited in a way that works with the docs. I can take that on separately, though.
|
|
||
| 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.
2 participants
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