Distutils command to build Sphinx documentation. The Sphinx build can then be triggered from distutils, and some Sphinx options can be set in ``setup.py`` or ``setup.cfg`` instead of Sphinx's own configuration file. For instance, from `setup.py`:: # this is only necessary when not using setuptools/distribute from sphinx.setup_command import BuildDoc cmdclass = {'build_sphinx': BuildDoc} name = 'My project' version = '1.2' release = '1.2.0' setup( name=name, author='Bernard Montgomery', version=release, cmdclass=cmdclass, # these are optional and override conf.py settings command_options={ 'build_sphinx': { 'project': ('setup.py', name), 'version': ('setup.py', version), 'release': ('setup.py', release)}}, ) Or add this section in ``setup.cfg``:: [build_sphinx] project = 'My project' version = 1.2 release = 1.2.0
Method | finalize |
Undocumented |
Method | initialize |
Undocumented |
Method | run |
Undocumented |
Class Variable | boolean |
Undocumented |
Class Variable | description |
Undocumented |
Class Variable | user |
Undocumented |
Instance Variable | all |
Undocumented |
Instance Variable | build |
Undocumented |
Instance Variable | builder |
Undocumented |
Instance Variable | builder |
Undocumented |
Instance Variable | config |
Undocumented |
Instance Variable | copyright |
Undocumented |
Instance Variable | doctree |
Undocumented |
Instance Variable | fresh |
Undocumented |
Instance Variable | keep |
Undocumented |
Instance Variable | link |
Undocumented |
Instance Variable | nitpicky |
Undocumented |
Instance Variable | pdb |
Undocumented |
Instance Variable | project |
Undocumented |
Instance Variable | release |
Undocumented |
Instance Variable | source |
Undocumented |
Instance Variable | today |
Undocumented |
Instance Variable | traceback |
Undocumented |
Instance Variable | verbosity |
Undocumented |
Instance Variable | version |
Undocumented |
Instance Variable | warning |
Undocumented |
Method | _guess |
Undocumented |