astropy / astropy/sphinx-automodapi

Add support for :noindex:

Open
#82 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

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.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the automodapi directive and its option parsing, then reproduce the reported Sphinx documentation build with the noindex option. Done means automodapi accepts :noindex: without the additional-options warning and the duplicated object description no longer causes the documentation build to fail.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.