sphinx.cmd.quickstart

module documentation
(source)

Quickly setup documentation source to work with Sphinx.

Class QuickstartRenderer No class docstring; 0/1 instance variable, 1/3 method documented
Exception ValidationError 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
Constant COLOR_QUESTION Undocumented
Constant DEFAULTS Undocumented
Constant EXTENSIONS Undocumented
Constant PROMPT_PREFIX Undocumented
Constant READLINE_AVAILABLE Undocumented
Constant USE_LIBEDIT Undocumented
def allow_empty(x): (source)

Undocumented

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

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:dict[str, Any]Undocumented
def boolean(x): (source)

Undocumented

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

Undocumented

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

Undocumented

Parameters
text:strUndocumented
default:str|NoneUndocumented
validator:Callable[[str], Any]Undocumented
Returns
str|boolUndocumented
def generate(d, overwrite=True, silent=False, templatedir=None): (source)

Generate project based on values in *d*.

Parameters
d:dictUndocumented
overwrite:boolUndocumented
silent:boolUndocumented
templatedir:str|NoneUndocumented
def get_parser(): (source)

Undocumented

Returns
argparse.ArgumentParserUndocumented
def is_path(x): (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
d:dictUndocumented
Returns
boolUndocumented
COLOR_QUESTION: str = (source)

Undocumented

Value
'bold'
DEFAULTS: dict = (source)

Undocumented

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

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 = (source)

Undocumented

Value
'> '
READLINE_AVAILABLE: bool = (source)

Undocumented

Value
True
USE_LIBEDIT: bool = (source)

Undocumented

Value
True