sphinx-automodapi
sphinx-automodapi copied to clipboard
astropy
Sphinx extension for generating API documentation
In automodsumm, we automatically check whether a ``references.txt`` file is present for the submodule being documented and if so injects it into every single docstring for that module: https://github.com/astropy/sphinx-automodapi/blob/master/sphinx_automodapi/automodsumm.py#L635 This...
Most people probably won't encounter this but it does happen when you have a subclass that shares the same name as its parent class. Example: ```python from astropy.modeling import models...
On some doc pages for classes (and possibly modules)--for example [`Polynomial2D`](http://docs.astropy.org/en/v1.0.3/api/astropy.modeling.polynomial.Polynomial2D.html)--under the "Attribute Documentation" literal values that involve unicode strings display them with the Python 2 style `u'...'` unicode literal...
Related to #156, but different--since automatic docstring inheritance isn't a normal "thing" in Python, Sphinx falls over a bit when this happens. Normally when we write a docstring we don't...
Hello, I have an [\_\_init\_\_.py](https://gitlab.com/picos-api/picos/blob/future+paths/picos/solvers/__init__.py) file that defines an exception and a number of functions. I want to document it as follows (from `/…/src/picos/doc/api/solvers.rst`): ``` .. automodapi:: picos.solvers :no-heading: :headings:...
In file `sphinx_automodapi/automodsumm.py`, there is a call to `find_mod_objs` that ignores the `no-inherited-members` flag. I don't know if this is correct or not, but in my use case, it does...
I get the following error when I try to use` automodsumm ` with a template when building matplotlib. `jinja2.exceptions.TemplateAssertionError: no filter named 'underline'`. The error happen in the call ```...
As originally mentioned in https://github.com/astropy/astropy-helpers/issues/195, it might be useful to have a way to be strict about requiring public functions, methods, and classes to have docstrings, so that we don't...
For Gammapy I would like to adopt the default of `include-all-objects` globally for the docs. How about adding a `automodapi_include_all_object` global Sphinx option? I think it's pretty common to want...
@mhvk - I see you've implemented an option to add module-level variables to automodapi in #24 . This is something I've wanted for Gammapy for a long time, thank you!...