Pull requests

#100 Merged
Repository
embray
Branch
fix-tocdepth
Repository
birkenfeld
Branch
default

Fixes a bug with :tocdepth: and inventory generation

Author
  1. Erik Bray
Reviewers
Description

This issue is also described at https://github.com/astropy/astropy/pull/595

Setting a non-zero :tocdepth: in a document prematurely halts processing of tables of contents in that document in sections at depths greater/equal to :tocdepth:. Instead, all tables of contents should be processed regardless of :tocdepth:, which should only control the presentation of the TOC for that page. This results in deceptive warnings like:

astropy/docs/changelog.rst:: WARNING: document isn't included in any toctree

which otherwise don't show up without the :tocdepth: option. I'd be happy to add a regression test too if you can tell me where it should go.

  • Learn about pull requests

Comments (1)