sphinx-automodapi
sphinx-automodapi copied to clipboard
astropy
Sphinx extension for generating API documentation
I have a python package module that imports 3rd party modules which aren't included in the sphinx documentation. So I added these modules to mock imports in the ``conf.py`` ```python...
First of all, thanks for this great extension! I've found it very useful, except for one detail: When using either the `automodapi` or `automodsumm` directives, all imported members of a...
E.g. at https://astropy.readthedocs.io/en/latest/visualization/index.html#module-astropy.visualization click on any class in the graph-viz Diagram - None of them work, because there is a "/latest/" missing in the url. I'm reporting this here, but...
Not sure what is happening but we need to make sure it is not a bug here before reporting it upstream to `sphinx`. This is blocking astropy/astropy#11763 . @larrybradley narrowed...
When this package was written, Sphinx was pretty young. Perhaps it has a built-in feature that can replace this package now; maybe https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html#sphinx-autogen-generate-autodoc-stub-pages ? Or is this not possible because...
As discussed at infrastructure tag-up today (2022-04-07) between @saimn , @eteq , @bsipocz , @tomdonaldson , and myself, this package might get better maintenance if it is in Sphinx proper....
Identified as an issue in https://github.com/astropy/pyvo/pull/289#issuecomment-1048753250 E.g. here the first one gets the `classes` and `functions` link, but the rest just a numbered ID, which is then not very informative...
Sphinx provides a mechanism, which is not normally supported in Python, to provide docstrings for class attributes and module-level variables. We use this in several places in Astropy to document...
windows-latest (2022) has missing GCC. Stop using `windows-2019` (c4821079296463dd006371b86320daa96fc085e0) when we can. Related: * astropy/pytest-doctestplus#178 * astropy/pytest-doctestplus#179 * actions/virtual-environments#5141