sphinx.cmd.make_mode

module documentation

sphinx-build -M command-line handling.

This replaces the old, platform-dependent and once-generated content of Makefile / make.bat.

This is in its own module so that importing it is fast. It should not import the main Sphinx modules (like sphinx.applications, sphinx.builders).

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Constant BUILDERS Undocumented
Class ​Make Undocumented
Function run​_make​_mode Undocumented
BUILDERS: list =

Undocumented

Value
[('', 'html', 'to make standalone HTML files'),
 ('', 'dirhtml', 'to make HTML files named index.html in directories'),
 ('', 'singlehtml', 'to make a single large HTML file'),
 ('', 'pickle', 'to make pickle files'),
 ('', 'json', 'to make JSON files'),
 ('', 'htmlhelp', 'to make HTML files and an HTML help project'),
 ('', 'qthelp', 'to make HTML files and a qthelp project'),
...
def run_make_mode(args):

Undocumented

Parameters
args:List[str]Undocumented
Returns
intUndocumented