b.d.autodoc_rstx : module documentation

Part of bzrlib.doc_generate

Generate reStructuredText source for the User Reference Manual. Loosely based on the manpage generator autodoc_man.py.

Written by the Bazaar community.

Function get_filename Provides name of manual
Function infogen Create manual in RSTX format
Function _get_body Build the manual content.
Function _get_section Build the manual part from topics matching that section.
Function _get_commands_section Build the commands reference section of the manual.
Function _dump_text Dump text for a topic to a file.
def get_filename(options):
Provides name of manual
def infogen(options, outfile):
Create manual in RSTX format
def _get_body(params, topic_dir):
Build the manual content.
def _get_section(registry, section, title, hdg_level1='#', hdg_level2='=', output_dir=None):
Build the manual part from topics matching that section.

If output_dir is not None, topics are dumped into text files there during processing, as well as being included in the return result.

def _get_commands_section(registry, title='Commands', hdg_level1='#', hdg_level2='=', output_dir=None):
Build the commands reference section of the manual.
def _dump_text(output_dir, topic, text):
Dump text for a topic to a file.
API Documentation for Bazaar, generated by pydoctor at 2020-09-24 01:31:11.