You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
My project (pysap) has two components: a pure python library and a C extension. Currently I'm using apidoc for building both, but wanted to switch to sphinx-autoapi as it's cleaner and seems a better approach than importing the modules.
I've already started playing with it in the autoapi branch, by using sphinx-autoapi for the python library and keeping apidoc for the C extension, but I don't see a clear way of integrate both documentation trees.
I'm wondering what would be the best way to support this kind of scenarios. Some ideas:
directly implement some kind of support for C extensions and/or allow multiple instances of sphinx-autoapi to be configured (e.g. one folder for a Python doc, another for a C extension one, etc.)
allow customization of the automatically inserted toctree index to allow addition of externally generated API docs (e.g. via a template)
Any thoughts?
The text was updated successfully, but these errors were encountered:
We're adding support for autodoc style directives. Would that cater for your use case? That way you can write your pure Python entries with the directives, and use normal Sphinx directives to document that C extension.
There's less automation this way but it would allow you to document both the pure python and C extension in your documentation.
My project (pysap) has two components: a pure python library and a C extension. Currently I'm using
apidoc
for building both, but wanted to switch tosphinx-autoapi
as it's cleaner and seems a better approach than importing the modules.I've already started playing with it in the autoapi branch, by using
sphinx-autoapi
for the python library and keepingapidoc
for the C extension, but I don't see a clear way of integrate both documentation trees.I'm wondering what would be the best way to support this kind of scenarios. Some ideas:
sphinx-autoapi
entries be placed there (in the same line than Allow which toctree node the entries are placed under to be configurable #97).sphinx-autoapi
to be configured (e.g. one folder for a Python doc, another for a C extension one, etc.)toctree
index to allow addition of externally generated API docs (e.g. via a template)Any thoughts?
The text was updated successfully, but these errors were encountered: