bootstraparse API Documentation Modules Classes Names
Clear Help

Search bar offers the following options:

  • Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
  • Wildcards. The below example searches for documents with words beginning with “foo”: foo*
  • Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search

    Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

  • Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Module Index

  • bootstraparse - 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:
    • modules - The modules in this folder are used to parse the website.
      • config - Interprets config files The Config will be loaded by the environment at runtime and should be accessed that way Usage:
      • context_mngr - 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,
      • environment - Module for containing super important variables Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and
      • error_mngr - Dedicated module for defining and interpreting errors as well as generating error messages You're probably here for log_message or log_exception.
      • export - Module for final generation of the translated website Usage:
      • 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:
      • 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:
      • preparser - Module for pre-parsing user files in preparation for the parser Usage:
      • sitecrawler - Module for file and directories repartition Usage:
      • sitecreator - Module sequencing the successive actions necessary for website building Usage:
      • 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...
      • template_mngr - Module for interpreting default or custom templates.
      • tools - Usage:
    • __main__ - Main program, use this to start parsing
API Documentation for bootstraparse, generated by pydoctor 22.5.1 at 2022-06-16 02:05:35.