sphinx.cmd.quickstart

module documentation

Quickly setup documentation source to work with Sphinx.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Constant COLOR​_QUESTION Undocumented
Constant DEFAULTS Undocumented
Constant EXTENSIONS Undocumented
Constant PROMPT​_PREFIX Undocumented
Constant USE​_LIBEDIT Undocumented
Variable readline Undocumented
Class ​Quickstart​Renderer No class docstring; 0/1 instance variable, 1/3 method documented
Class ​Validation​Error Raised for validation errors.
Function allow​_empty Undocumented
Function ask​_user Ask the user for quickstart values missing from d.
Function boolean Undocumented
Function choice Undocumented
Function do​_prompt Undocumented
Function generate Generate project based on values in d.
Function get​_parser Undocumented
Function is​_path Undocumented
Function is​_path​_or​_empty Undocumented
Function main Undocumented
Function nonempty Undocumented
Function ok Undocumented
Function suffix Undocumented
Function term​_input Undocumented
Function valid​_dir Undocumented
COLOR_QUESTION: str =

Undocumented

Value
'bold'
DEFAULTS: dict =

Undocumented

Value
{'path': '.',
 'sep': False,
 'dot': '_',
 'language': None,
 'suffix': '.rst',
 'master': 'index',
 'makefile': True,
...
EXTENSIONS =

Undocumented

Value
OrderedDict([('autodoc', __('automatically insert docstrings from modules')),
             ('doctest',
              __('automatically test code snippets in doctest blocks')),
             ('intersphinx',
              __('link between Sphinx documentation of different projects')),
             ('todo',
              __('write "todo" entries that can be shown or hidden on build')),
...
PROMPT_PREFIX: str =

Undocumented

Value
'> '
USE_LIBEDIT: bool =

Undocumented

Value
False
readline =

Undocumented

def allow_empty(x):

Undocumented

Parameters
x:strUndocumented
Returns
strUndocumented
def ask_user(d):

Ask the user for quickstart values missing from d.

Values are:

  • path: root path
  • sep: separate source and build dirs (bool)
  • dot: replacement for dot in _templates etc.
  • project: project name
  • author: author names
  • version: version of project
  • release: release of project
  • language: document language
  • suffix: source file suffix
  • master: master document name
  • extensions: extensions to use (list)
  • makefile: make Makefile
  • batchfile: make command file
Parameters
d:DictUndocumented
def boolean(x):

Undocumented

Parameters
x:strUndocumented
Returns
boolUndocumented
def choice(*l):

Undocumented

Parameters
*l:strUndocumented
Returns
Callable[[str], str]Undocumented
def do_prompt(text, default=None, validator=nonempty):

Undocumented

Parameters
text:strUndocumented
default:strUndocumented
validator:Callable[[str], Any]Undocumented
Returns
Union[str, bool]Undocumented
def generate(d, overwrite=True, silent=False, templatedir=None):
Generate project based on values in d.
Parameters
d:DictUndocumented
overwrite:boolUndocumented
silent:boolUndocumented
templatedir:strUndocumented
def get_parser():

Undocumented

Returns
argparse.ArgumentParserUndocumented
def is_path(x):

Undocumented

Parameters
x:strUndocumented
Returns
strUndocumented
def is_path_or_empty(x):

Undocumented

Parameters
x:strUndocumented
Returns
strUndocumented
def main(argv=sys.argv[1:]):

Undocumented

Parameters
argv:List[str]Undocumented
Returns
intUndocumented
def nonempty(x):

Undocumented

Parameters
x:strUndocumented
Returns
strUndocumented
def ok(x):

Undocumented

Parameters
x:strUndocumented
Returns
strUndocumented
def suffix(x):

Undocumented

Parameters
x:strUndocumented
Returns
strUndocumented
def term_input(prompt):

Undocumented

Parameters
prompt:strUndocumented
Returns
strUndocumented
def valid_dir(d):

Undocumented

Parameters
d:DictUndocumented
Returns
boolUndocumented