diff --git a/apidoc/all-documents.html b/apidoc/all-documents.html index b6d75e9..1c7029a 100644 --- a/apidoc/all-documents.html +++ b/apidoc/all-documents.html @@ -139,7 +139,7 @@
Package
Package
PUBLIC
-
No package docstring; 1/1 module, 1/1 package documented
+
Bootstraparse is a tool to parse a folder and create a website from it. After installing it with pip, you can use it by running the following command:
  • bootstraparse.__main__
    @@ -163,7 +163,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 1/1 class documented
    +
    Interprets config files The Config will be loaded by the environment at runtime and should be accessed that way Usage:
  • bootstraparse.modules.context_mngr
    @@ -171,7 +171,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 0/1 variable, 2/19 classes documented
    +
    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,
  • bootstraparse.modules.environment
    @@ -179,7 +179,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 1/1 class documented
    +
    Module for containing super important variables Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and
  • bootstraparse.modules.error_mngr
    @@ -187,7 +187,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 0/1 constant, 3/3 functions, 4/4 classes documented
    +
    Dedicated module for defining and interpreting errors as well as generating error messages You're probably here for log_message or log_exception.
  • bootstraparse.modules.export
    @@ -195,7 +195,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 1/2 variable, 1/1 function, 2/2 classes documented
    +
    Module for final generation of the translated website Usage:
  • bootstraparse.modules.parser
    @@ -203,7 +203,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 1/1 function documented
    +
    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:
  • bootstraparse.modules.pathresolver
    @@ -211,7 +211,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 0/1 variable, 2/2 classes documented
    +
    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:
  • bootstraparse.modules.preparser
    @@ -219,7 +219,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 1/1 class documented
    +
    Module for pre-parsing user files in preparation for the parser Usage:
  • bootstraparse.modules.sitecrawler
    @@ -227,7 +227,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 1/1 class documented
    +
    Module for file and directories repartition Usage:
  • bootstraparse.modules.sitecreator
    @@ -235,7 +235,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    No module docstring; 5/5 functions documented
    +
    Module sequencing the successive actions necessary for website building Usage:
  • bootstraparse.modules.syntax
    @@ -251,7 +251,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    Undocumented
    +
    Module for interpreting default or custom templates.
  • bootstraparse.modules.tools
    @@ -259,7 +259,7 @@
    ZopeInterfaceModule
    Module
    PUBLIC
    -
    ############################################################################### # List of tools for testing ############################################################################### # Usage: # from bootstraparse...
    +
    Usage:
  • bootstraparse.modules.pathresolver.PathResolver
    diff --git a/apidoc/bootstraparse.__main__.html b/apidoc/bootstraparse.__main__.html index a96e717..a4c9e88 100644 --- a/apidoc/bootstraparse.__main__.html +++ b/apidoc/bootstraparse.__main__.html @@ -318,7 +318,7 @@
    API Documentation for bootstraparse, generated by pydoctor - 22.5.1 at 2022-06-15 22:32:36. + 22.5.1 at 2022-06-15 22:51:02.