CheckSources¶

CheckSources is a preprocessor that checks the project’s chapters for missing and unmentioned files in the sources directory.

$ pip install foliantcontrib.checksources

To enable the preprocessor, add checksources to preprocessors section in the project config:

preprocessors:
    - checksources

You can add a list of unmentioned files that wouldn't throw warnings by not_in_chapters option:

preprocessors:
    - checksources:
        not_in_chapters:
          - tags.md

It is useful if you don't need to add some files to the table of contents.