TTD Toctree

QA test (Toctree Validation) for sphinx based documentation

This test checks for multiple :numbered: entries.

Following our write guidelines we allow this setting once in index.rst.

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

Features

• Small Image, based on Alpine Linux.
• Uses Tini as init.
• Uses su-exec for setting permissions.
• Uses The Silver Searcher for speed and better configuration.

Dependencies

• Docker

Installation

Pull the image:

docker pull testthedocs/ttd-toctree

Usage

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

Run The Test

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

Contribute

• Issue Tracker
• Source Code

Support

If you are having issues, please let us know.

License

MIT