TTD Toctree

Abstract

Toctree validation for sphinx based documentation.

This test checks for multiple :numbered: entries.

This tests checks all reStructuredText (.rst) files, if the test detects :numbered: in another file than index.rst it reports an error.

Installation

Dependencies

• Docker

Usage

Navigate to the directory containing your reStructuredText (.rst) files.

docker run -it -v `pwd`:/build/docs testthedocs/ttd-toctree

Source Code

The code of ttd-toctree is located on GitHub.