A tool to preprocess root documentation in order to provide missing functionality in the documentation tools like doxygen or pandoc. More...
Functions | |
| applyFilters (filename) | |
| Apply a series of filters to the file modifiying its content. | |
| checkInvocation (argv) | |
| Check if the invocation is correct. | |
| createPreprocessedName (filename) | |
| Create a name for the preprocessed version of filename. | |
| includeFilter (text) | |
| If a line of the form @ROOT_INCLUDE_FILE filename is encountered, it is replaced with the content of filename. | |
| preprocessFile () | |
| Apply a series of "filters" to the input file. | |
| printErrAndUsage (msg) | |
Variables | |
| list | textFilters = [includeFilter] |
| str | usage = "Usage: %s fileToBeTreated.md\n" %__file__ |
A tool to preprocess root documentation in order to provide missing functionality in the documentation tools like doxygen or pandoc.
At the moment filters are just functions. A proper implementation would go through the creation of a filter class which is very genereic and can be composed with a trigger and an action.
| rootDocPreprocessor.applyFilters | ( | filename | ) |
Apply a series of filters to the file modifiying its content.
A new file is created with the suffix _preprocessed before the extension. For example: myChapter.md --> myChapter_preprocessed.md
Definition at line 64 of file rootDocPreprocessor.py.
| rootDocPreprocessor.checkInvocation | ( | argv | ) |
Check if the invocation is correct.
If not print help
Definition at line 20 of file rootDocPreprocessor.py.
| rootDocPreprocessor.createPreprocessedName | ( | filename | ) |
Create a name for the preprocessed version of filename.
Definition at line 33 of file rootDocPreprocessor.py.
| rootDocPreprocessor.includeFilter | ( | text | ) |
If a line of the form @ROOT_INCLUDE_FILE filename is encountered, it is replaced with the content of filename.
Definition at line 40 of file rootDocPreprocessor.py.
| rootDocPreprocessor.preprocessFile | ( | ) |
Apply a series of "filters" to the input file.
Definition at line 82 of file rootDocPreprocessor.py.
| rootDocPreprocessor.printErrAndUsage | ( | msg | ) |
Definition at line 16 of file rootDocPreprocessor.py.
| list rootDocPreprocessor.textFilters = [includeFilter] |
Definition at line 62 of file rootDocPreprocessor.py.
| str rootDocPreprocessor.usage = "Usage: %s fileToBeTreated.md\n" %__file__ |
Definition at line 14 of file rootDocPreprocessor.py.
