sphinx-autoapi
sphinx-autoapi copied to clipboard
readthedocs
A new approach to API documentation in Sphinx.
How can I cross reference to the documentation of a specific function, which has been generated by `sphinx-autoapi`? We are using markdown (through the MyST parser) in our documentation -...
Hello all, Im running into an issue sphinx cannot seem to locate the autoAPI extension. For reference I used `pip install sphinx-autoapi` and I included it in the extensions list...
Apologies if this is just me missing something - I'm new to both `sphinx` and `autoapi`, but: in contrast to the docs, `__all__` does not seem to be respected in...
Error: ``` Extension error (autoapi.extension): Handler for event 'builder-inited' threw an exception (exception: dictionary changed size during iteration) ``` Relevant branch to test if needed: https://github.com/Ouranosinc/cowbird/pull/53 (can call `make docs`...
Thank you for this great project! I notice that methods decorated with [`functools.cached_property`](https://docs.python.org/3/library/functools.html#functools.cached_property) (introduced in Python 3.8) render as generic methods, while those decorated with `property` are handled differently (leading...
I am currently using autoapi to generate the documentation for my [project](https://github.com/JeschkeLab/autoDEER) . The docs build with no issues on my laptop however on github actions I keep running into...
I am new to `sphinx` and `autoapi` so I may be missing something, but I searched the documentation and the internet and couldn't find a solution to my problem. I...
## Observed behavior In an rst file with content like: ```rst Autodoc Directives ================== .. autoapimodule:: example :members: :noindex: Non-existing code references ---------------------------- .. autoapifunction:: test_example.bar_test ``` Where `example` is...
It's more convenient to have everything available in the devcontainer to build the autoapi docs or run tox for test directly after building the devcontainer.
My new warning implemented in https://github.com/readthedocs/sphinx-autoapi/pull/431 shows that the autoapi references in the templates.rst are actually broken.
Metadata
Owner
Metadata
A new approach to API documentation in Sphinx.