sphinx.cmd.build

module documentation
(source)

Build documentation from a provided source.

Function build_main Sphinx build "main" command-line entry.
Function get_parser Undocumented
Function handle_exception Undocumented
Function jobs_argument Special type to handle 'auto' flags passed to 'sphinx-build' via -j flag. Can be expanded to handle other special scaling requests, such as setting job count to cpu_count.
Function main Undocumented
Function make_main Sphinx build "make mode" entry.
Function _bug_report_info Undocumented
Function _parse_arguments Undocumented
def build_main(argv=sys.argv[1:]): (source)

Sphinx build "main" command-line entry.

Parameters
argv:list[str]Undocumented
Returns
intUndocumented
def get_parser(): (source)

Undocumented

Returns
argparse.ArgumentParserUndocumented
def handle_exception(app, args, exception, stderr=sys.stderr): (source)

Undocumented

Parameters
app:Sphinx|NoneUndocumented
args:AnyUndocumented
exception:BaseExceptionUndocumented
stderr:TextIOUndocumented
def jobs_argument(value): (source)

Special type to handle 'auto' flags passed to 'sphinx-build' via -j flag. Can be expanded to handle other special scaling requests, such as setting job count to cpu_count.

Parameters
value:strUndocumented
Returns
intUndocumented
def main(argv=sys.argv[1:]): (source)

Undocumented

Parameters
argv:list[str]Undocumented
Returns
intUndocumented
def make_main(argv=sys.argv[1:]): (source)

Sphinx build "make mode" entry.

Parameters
argv:list[str]Undocumented
Returns
intUndocumented
def _bug_report_info(): (source)

Undocumented

Returns
intUndocumented
def _parse_arguments(argv=sys.argv[1:]): (source)

Undocumented

Parameters
argv:list[str]Undocumented
Returns
argparse.NamespaceUndocumented