sphinx-automodapi
sphinx-automodapi copied to clipboard
astropy
Sphinx extension for generating API documentation
Implements item 2 from #91. This adds and documents the `automodsumm_included_members` option, which is used to add private methods other than `__init__` and `__call__` to the online documentation. This is...
Implements item 1 from #91. This adds and documents the `automodsumm_ignore_emptydoc` flag and `:ignore-emptydoc:` and `:no-ignore-emptydoc:` options, which can be thought of as an expansion of `automodsumm_inherited_methods`, `:inherited-methods:`, and `:no-inherited-methods:`....
Hi, great package! I have one problem: automodapi seems to ignore `dataclass` fields if they are initialized with the `field` method or annotated with a `typing` type: ```python from dataclasses...
@Cadair introduced me to `automodapi` today and it seems awesome. But it took some thorough explaining before I realised that and understood what it does. I think a lot of...
I'm using python 3.7.7, sphinx 3.0.3 and the latest automodapi. The following problem occurs: I get these kind of warnings: "WARNING: Found additional options members in automodapi" however it causes...
I have a package with Sphinx documentation at https://sdrast.github.io/Data_Reduction/. `automodapi` fails on certain modules in the package with the error: ``` Exception occurred: File "/usr/local/anaconda3/lib/python3.7/site-packages/sphinx_automodapi/utils.py", line 99, in find_mod_objs fqnames.append(obj.__module__...
For example, ```rst .. function numpy.clip :: ``` And how can I custom the prefix to be `np.clip`? Or simply `clip`? See https://taichi-glsl.readthedocs.io/en/latest/api/taichi_glsl.glsl.clamp.html, my users are expected to `import taichi_glsl...
Let's consider the following class hierarchy: ``SpectralAxis(SpectralCoord(SpectralQuantity(Quantity(ndarray))))`` - it would be nice to have a way to document ``SpectralAxis``, including all the methods on ``SpectralCoord`` and ``SpectralQuantity``, but ignoring ``Quantity``...
Hello, I just start using autodocapi this morning. It seems that some of my class are correctly populating with methods and attributes... except if the class name don't start with...
I am trying to document a routes.py/views.py script for a flask app. However, the build fails on `from flask import request`. I deduced this by commenting out lines until I...
