package documentation
The modules in this folder are used to parse the website.
| Module | config |
Interprets config files The Config will be loaded by the environment at runtime and should be accessed that way Usage: |
| Module | context |
Interprets where the parser is located and resolves errors You're probably here for the ContextManager class. Containers have class_name, debug_map and validate methods for debug, |
| Module | environment |
Module for containing super important variables Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and |
| Module | error |
Dedicated module for defining and interpreting errors as well as generating error messages You're probably here for log_message or log_exception. |
| Module | export |
Module for final generation of the translated website Usage: |
| Module | parser |
Main parser, gets config files and parses them for the context manager. parse_line takes a io and outputs it all as a list of parsed elements Usage: |
| Module | pathresolver |
Module for resolving relative path problems PathResolver takes a relative path in the module and outputs the absolute path, BoostraPath can deal with relative paths in the installation folder. Usage: |
| Module | preparser |
Module for pre-parsing user files in preparation for the parser Usage: |
| Module | sitecrawler |
Module for file and directories repartition Usage: |
| Module | sitecreator |
Module sequencing the successive actions necessary for website building Usage: |
| Module | syntax |
# Dedicated module for the syntax of all the parsing # All tokens inherit a SemanticType among SemanticType, ExplicitSemanticType and EmptySemanticType # All tokens have a label, and __eq__ and __ne__ methods... |
| Module | template |
Module for interpreting default or custom templates. |
| Module | tools |
Usage: |