Generate markdown docs for a Python package composed only of bindings #315
Unanswered
ChristopherRabotin
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
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hi there,
I am trying to generate the markdown of the documentation of anise, a Rust project which has Python bindings and is available to install on pip. The Python bindings are generate via PyO3.
When I run pydoc-markdown, after installing it in the same virtual environment as the one I develop
anise
in, it just reports an empty page:However, some basic Python documentation should be available, and is available within the Python interpreter:
That documentation seems to also be available to Python's
pydoc
but it's in HTML (and my website uses mkdocs).Is there a way for pydoc-markdown to generate to markdown for that documentation by importing all of the submodules and calling
__doc__
on it instead of parsing the Python files (which is what I'm guessing it does)?Thanks
Beta Was this translation helpful? Give feedback.
All reactions