DocWalker
A class that walks a module structure, generating .md files for every class inside it as well as for global functions,
and a Markdown index file.
Takes a set of objects & writers and walks through the objects, generating files on the way.
module_handler: ModuleWriter
class_handler: ClassWriter
function_handler: FunctionWriter
method_handler: MethodWriter
object_handler: ObjectWriter
index_handler: IndexWriter
spec: DocSpec
__init__(self, out=None, engine=None, verbose=True, template_locator=None, examples_directory=None, tests_directory=None, **extra_fields):
objects:Iterable[Any]the objects to write out
out:None | strthe directory in which to write the files (
Nonemeanssys.stdout)ignore_paths:None | Iterable[str]a set of paths not to write (passed to the objects)
get_engine(self, locator):
get_examples_loader(self, examples_directory):
get_tests_loader(self, tests_directory):
get_handler(self, *args, examples_loader=None, tests_loader=None, **kwargs):
visit_root(self, o, tests_directory=None, examples_directory=None, **kwargs):
A DocWalker object is a light subclass of a TemplateWalker, but specialized for documentation & with specialized handlers
See Also
DocBuilder ▪ ModuleWriter ▪ ClassWriter ▪ FunctionWriter ▪ MethodWriter ▪ ObjectWriter ▪ IndexWriter