-
Notifications
You must be signed in to change notification settings - Fork 61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use autodoc for Python API reference #1172
Comments
Regarding type signatures, things are hairy. An incomplete list of ingredients/options for generation the eventual html docs: Python code:
Python docstrings:
Signatures in docs is a duplication of information that you have to keep synchronized with API manually, and therefore has not my preference. Pybind:
Sphinx:
Various stubgens:
Problem:
Summary:At this time I'm not able to get the outputs (pervasive type options/hints) automatically generated, or documented in member docstrings. Potential alternatives that are not sufficient after all:
Action:
|
##An option in the meantime: In an earlier PR #1176, I wrote a script that hooks into Sphinx to dump the We could generate the autodoc
Adding in the type annotations by hand for the getters isn't much work:
Which produces acceptable output: Updating is manual, but by checking the full reference in, a difftool can be used. |
Hi, this has been dormant for quite some time, what's the current stance on this? |
Took a tour of the above linked blocking issues/PRs, no progress: python/cpython#83306 |
Type annotations are resolved |
Using the
sphinx.ext.autodoc
plugin to autogenerate Python Api documentation accomplishes the following:help()
and the docs will show the same documentation.Requirements:
sphinx.ext.autodoc
requires an importablearbor
module, so building the docs requires Arbor be built.Options:
The text was updated successfully, but these errors were encountered: