Foliant preprocessor that checks the project for missing and unmentioned files.
Project description
CheckSources
CheckSources is a preprocessor that checks the project’s chapters
for missing and unmentioned files in the sources directory.
Installation
$ pip install foliantcontrib.checksources
Usage
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.
To perform a strict check, use the strict_check
option:
preprocessors:
- checksources:
not_in_chapters:
- tags.md
strict_check: true
The not_in_chapters
option is useful if you don't need to add some files to the table of contents.
If the strict_check
option is enabled, then if a critical error is detected, the build will be aborted after applying the preprocessor.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for foliantcontrib.checksources-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b56746e9765b4e5c26dabbe8b070ed9a17d2347830fcf98b16413fc5a6e8487f |
|
MD5 | c3be126b14c03003274d8325f883616c |
|
BLAKE2b-256 | a529b9447f083ec6fb10401cb8cd7dc90d480a34541f382b2c84a7b64623a15d |
Hashes for foliantcontrib.checksources-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19de8365351e4c883358531e983c7f29c2a4cb8b8610dd72605ec1226b25a1a4 |
|
MD5 | 23392f5920c44b478e61cad8e63709df |
|
BLAKE2b-256 | 9d2046b62bb1a3cf6dccdab96031adca203963a27f40a76bf20669bed438d597 |