sphinx-automodapi
sphinx-automodapi copied to clipboard
astropy
Sphinx extension for generating API documentation
I just started trying to get class docs today and liked how the automodapi was formatting them with one class per file and not having to hand enter all the...
If I document instance variables as follows ```python class A: def __init__(self): self.a = None """Documented instance variable.""" ``` then they do not show up in the attributes section (or...
I'm using the current `master` branch of the astropy package template to build docs in my package [`pyoof`](https://github.com/tcassanelli/pyoof). Everything works fine in the offline version, but when the online version...
When I tried to use it under `..only:: html`, I got a warning and nothing was generated. Code : ``` .. only:: html .. automodule:: mymodule :members: :undoc-members: .. automodapi::...
E.g. trying it in astroquery.mast (it was part of an experiment only) ``` Reference/API ============= .. automodapi:: astroquery.mast :no-heading: :no-inheritance-diagram: ``` I get this warning: ``` /Users/bsipocz/munka/devel/astroquery/docs/mast/mast.rst:758: WARNING: Title level...
Sphinx autodoc uses `autodoc_mock_imports` to, well, mock imports. Trying to mock modules with `MagicMock` causes them to be excluded from the compiled docs, see https://github.com/sphinx-doc/sphinx/issues/4956 Since automodapi doesn't respect `autodoc_mock_imports`,...
I have developed a package which for the most part contains functions in different modules within the package. I am documenting these functions wonderfully using automodsumm. But the package also...
As the title says, you would have to execute `sphinx-build -b doctest` (or `make doctest`) twice if you want to run all your tests starting from a fresh environment (e.g....
Hello, when I set the type of a parameter to something available through intersphinx, e.g. `:type param: cvxopt.matrix` or `:type param: cvxopt:cvxopt.matrix` where `cvxopt` was successfully fetched via intersphinx, I...
It seems like the opposite effect of #52 is happening as of version 0.9: Class members for ABC-derived classes are displayed twice. Please refer to https://gitlab.com/picos-api/picos/issues/117 for a full issue...