Different rending results from YAML versus Python API #333
Unanswered
sarahwooders
asked this question in
Q&A
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I am trying to autogenerate documentation for a Python class. I initially tried using the YAML configuration with the following file:
This successfully generated markdown in the format I wanted (for the arguments and returns):
I need to use the Python Client to control which classes have markdown docs generated for them, however I cannot reproduce the same rendering with the python client. I instead get the following:
Note that the arguments and returns are not formatted properly, which do not render properly for markdown. I am using the following python script (have tried both variations of the API examples https://niklasrosenstein.github.io/pydoc-markdown/usage/cli-and-api/#api-example):
Can I please get some help with this? Thank you!
Beta Was this translation helpful? Give feedback.
All reactions