Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
dockerfiles
.gitignore
CHANGELOG.rst
LICENSE
Makefile
README.rst
VERSION
testtoctree.sh

README.rst

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

Dependencies

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

docs/_static/ttd-testtoc.gif

Contribute

Support

If you are having issues, please let us know.

License

MIT