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

Fixes a bug with :tocdepth: and inventory generation

Author
  1. Erik Bray avatarErik 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.

Comments (1)

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.