sphinx.cmd.build

module documentation

Build documentation from a provided source.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
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.
def build_main(argv=sys.argv[1:]):
Sphinx build "main" command-line entry.
Parameters
argv:List[str]Undocumented
Returns
intUndocumented
def get_parser():

Undocumented

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

Undocumented

Parameters
app:SphinxUndocumented
args:AnyUndocumented
exception:BaseExceptionUndocumented
stderr:IOUndocumented
def jobs_argument(value):
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:]):

Undocumented

Parameters
argv:List[str]Undocumented
Returns
intUndocumented
def make_main(argv=sys.argv[1:]):
Sphinx build "make mode" entry.
Parameters
argv:List[str]Undocumented
Returns
intUndocumented