Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for :noindex: #82

Open
bsipocz opened this issue Jun 2, 2019 · 1 comment
Open

Add support for :noindex: #82

bsipocz opened this issue Jun 2, 2019 · 1 comment

Comments

@bsipocz
Copy link
Member

bsipocz commented Jun 2, 2019

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 of them
Sphinx Documentation subprocess failed with return code 2
Exited with code 2

However currently the automodapi directive doesn't support noindex (WARNING: Found additional options noindex in automodapi.)
and no-heading doesn't do the trick.

@adrn
Copy link
Member

adrn commented Apr 25, 2021

Just re-discovered this! One workaround is to use the :no-main-docstr: option, but then you lose the main docstring (not a problem in my use cases).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants