sphinx-autoapi
sphinx-autoapi copied to clipboard
readthedocs
A new approach to API documentation in Sphinx.
This warning is shown by sphinx build now when the "fullname" in the autoapi directive cannot be found in the imports, e.g. `.. autoapiclass:: autoapi.mappers.python.objects.PythonPythonMapper` give: ``` reading sources... [100%]...
If a module has an `if __name__ == '__main__:` block, the first element is analysed and its documentation is generated. The next ones are ignored. This is regardless if it...
Hi, I've started updating my codebases to Python 3.12, including adding type aliases via `type CustomType = dict[str, int] | list[int]` and sharing them across files via `from src.module import...
Running the tests outputs the following warning: ``` .tox/py312/lib/python3.12/site-packages/sphinx/ext/autodoc/__init__.py:818: RemovedInSphinx80Warning: Returning tuples of (name, object) as the second return value from get_object_members() is deprecated. Return ObjectMember(name, object) instances instead. for...
I would like to refactor the configuration of the lib to move everything from setup.cfg to pyproject.toml. Is is a wanted feature ?
Much of the code isn't type annotated currently. We should be aiming to be able to enable strict type checking to get as much benefit from type checking as possible.
To document my deprecation cycles, I usually use the [deprecated](https://pypi.org/project/Deprecated/) lib. It's as simple to use as this: ```pyhton from deprecated.sphinx import deprecated @deprecated(version='1.0', reason="This function will be removed soon")...
This is a port of an issue from Sphinx (https://github.com/sphinx-doc/sphinx/issues/12026) ## The original issue: ### Describe the bug building sphinx the build fails if the child class is smaller than...
When we generate documentation for classes, we have two situations: 1. We wrote a base class with various attributes and methods that we want exposed to the user, and we...
Hey! Our build is popping up a new warning after upgrading to the latest sphinx and autoapi. ``` /home/sam/Code/specs/autoapi_mre/doc/autoapi/file3/index.rst:33:more than one target found for cross-reference 'Transaction': file1.Transaction, file2.Transaction ``` Here's...
Metadata
Owner
Metadata
A new approach to API documentation in Sphinx.