setup module¶
Setup script
-
class
setup.
BakedDocumentation
(dist, **kw)[source]¶ Bases:
setuptools.Command
-
description
= 'create documentation distribution from baked project'¶
-
user_options
= []¶
-
-
class
setup.
Clean
(dist, **kw)[source]¶ Bases:
setuptools.Command
Custom clean command to tidy up the project root.
-
user_options
= []¶
-
-
class
setup.
Cookiecutter
(dist, **kw)[source]¶ Bases:
setuptools.Command
Bake the cookies
-
description
= 'bake the cookiecutter'¶
-
user_options
= [('no-input', None, 'Do not prompt for parameters and only use cookiecutter.json file content', ' [default: False]'), ('replay', None, 'Do not prompt for parameters and only use information entered previously [default: letter]')]¶
-
-
class
setup.
Documentation
(dist, **kw)[source]¶ Bases:
setuptools.Command
Bake the cookies
-
description
= 'create documentation distribution'¶
-
targets
= {'dirhtml': {'comment': 'The HTML pages are in {build_dir!s}.'}, 'latex': {'comment': 'The LaTeX files are in {build_dir!s}.'}, 'html': {'comment': 'The HTML pages are in {build_dir!s}.'}, 'singlehtml': {'comment': 'The HTML pages are in {build_dir!s}.'}}¶
-
user_options
= [('builder=', None, 'documentation output format [default: html]'), ('paper=', None, 'paper format [default: letter]'), ('dist-dir=', None, 'directory to put final built distributions in [default: dist/docs]'), ('build-dir=', None, 'temporary directory for creating the distribution [default: build/docs]'), ('src-dir=', None, 'documentation source directory [default: docs')]¶
-
-
class
setup.
Venv
(dist, **kw)[source]¶ Bases:
setuptools.Command
Setup venvs for development or production
-
description
= 'create a virtualenv pre-installed with dependencies'¶
-
user_options
= [('deps=', None, 'path to requirements.txt')]¶
-