astropy / astropy/sphinx-automodapi

:no-heading: raises "WARNING: Title level inconsistent"

Open
#81 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

E.g. trying it in astroquery.mast (it was part of an experiment only)

```
Reference/API
=============

.. automodapi:: astroquery.mast
:no-heading:
:no-inheritance-diagram:
```

I get this warning:
```
/Users/bsipocz/munka/devel/astroquery/docs/mast/mast.rst:758: WARNING: Title level inconsistent:

Classes
^^^^^^^
```

Generated summary with no heading:

Screen Shot 2019-06-02 at 16 24 46

vs with the heading on:
Screen Shot 2019-06-02 at 16 25 31

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the warning from the `astroquery.mast` example in `docs/mast/mast.rst` around line 758, focusing on the `automodapi` directive with `:no-heading:`. Trace how the directive generates the Classes section and confirm completion when the example builds without the title-level warning while retaining the intended no-heading output.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.