DocBuilder
A documentation builder class that uses a DocWalker
to build documentation, but which also has support for more
involved use cases, like setting up a _config.yml
or other
documentation template things.
defaults_root: str
default_config_file: str
default_template_extension: str
default_repo_extension: str
config_defaults: dict
__init__(self, packages=None, config=None, target=None, root=None, config_file=None, templates_directory=None, examples_directory=None, tests_directory=None, readme=None):
packages
:Iterable[str|dict]
list of package configs to write
config
:dict
parameters for _config.yml file
target
:str
target directory to which files should be written
root
:str
root directory root directory
get_template_locator(self, template_directory, use_repo_templates=False):
load_config(self):
Loads the config file to be used and fills in template parameters
:returns
:_
create_layout(self):
Creates the documentation layout that will be expanded upon by
a DocWalker
:returns
:_
load_walker(self):
Loads the DocWalker
used to write docs.
A hook that can be overriden to sub in different walkers.
:returns
:_
build(self):
Writes documentation layout to self.target
:returns
:_
See Also
DocWalker
▪ ModuleWriter
▪ ClassWriter
▪ FunctionWriter
▪ MethodWriter
▪ ObjectWriter
▪ IndexWriter