sphinx-automodapi

sphinx-automodapi copied to clipboard

Someone with admin access to https://readthedocs.org/projects/sphinx-automodapi/ need to change the branch name from `master` to `main`.

pllim

Issue with case sensitivity on MacOS X

9

Astropy has ``M_bol`` and ``m_bol`` objects in the same sub-package, and this causes issues when using sphinx-automodapi because MacOS X is case-insensitive meaning that the .rst pages for each of...

astrofrog

I didn't get `automodsumm` to work with templates in the way that I wanted #46. This is a solution that works for my application but I don't understand the code...

fredrik-1

Support for non-default dataclass fields

3

Hi, this PR tries to fix this issue: https://github.com/astropy/sphinx-automodapi/issues/115. Used sphinx version: 3.2.1 Python version: 3.8.5 Fix #115

waszil

Options to document private/special methods

1

Implements two new options for enabling the documenting of private and/or special methods. Only enabled for class names listed in config file. Class names must be given in full, e.g.,``...

ConorMacBride

Using something like this: ```rst .. automodsumm:: MODULE :nosignatures: ``` Works as intended (signatures are not included), but produces this spurious warning: ``` .venv/lib/python3.8/site-packages/sphinx_automodapi/utils.py:179: UserWarning: :nosignatures: warn(line) ``` https://github.com/astropy/sphinx-automodapi/blob/main/sphinx_automodapi/utils.py#L178-L180

simaoafonso-pwt

Avoid warnings when accessing attributes on classes that may not be regular properties

3

In astropy core, we need to do horrendous things like: https://github.com/astropy/astropy/blob/46ca59e9a0bfa3b6687411ea7a6364fdebf91914/astropy/visualization/wcsaxes/patches.py#L17-L26 because sometimes Matplotlib deprecate properties - however because those are custom properties and not regular properties, we make use...

astrofrog

Hey, some themes like sphinx_rtd_theme emit "Edit on GitHub" links to the page source in the git repository. For autogenerated pages this link points to something that doesn't exist, i.e....

coldfix

Add support for :noindex:

1

Sphinx 2.1 became more strict and now complains about duplicated object descriptions: ``` Warning, treated as error: duplicate object description of astropy.nddata.utils, other instance in nddata/index, use :noindex: for one...

bsipocz

This PR addresses item 3 from #91. It permits using "stub pages" for classes attributes and class methods, controlled by the `automodsumm_stub_pages` option. The default is `False`. It inserts `process_automodapi`...

lukelbd