class documentation

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_options Undocumented
Method initialize_options Undocumented
Method run Undocumented
Class Variable boolean_options Undocumented
Class Variable description Undocumented
Class Variable user_options Undocumented
Instance Variable all_files Undocumented
Instance Variable build_dir Undocumented
Instance Variable builder Undocumented
Instance Variable builder_target_dirs Undocumented
Instance Variable config_dir Undocumented
Instance Variable copyright Undocumented
Instance Variable doctree_dir Undocumented
Instance Variable fresh_env Undocumented
Instance Variable keep_going Undocumented
Instance Variable link_index Undocumented
Instance Variable nitpicky Undocumented
Instance Variable pdb Undocumented
Instance Variable project Undocumented
Instance Variable release Undocumented
Instance Variable source_dir Undocumented
Instance Variable today Undocumented
Instance Variable traceback Undocumented
Instance Variable verbosity Undocumented
Instance Variable version Undocumented
Instance Variable warning_is_error Undocumented
Method _guess_source_dir Undocumented
def finalize_options(self): (source)

Undocumented

def initialize_options(self): (source)

Undocumented

def run(self): (source)

Undocumented

boolean_options: list[str] = (source)

Undocumented

description: str = (source)

Undocumented

user_options: list = (source)

Undocumented

all_files: bool = (source)

Undocumented

build_dir = (source)

Undocumented

Undocumented

builder_target_dirs = (source)

Undocumented

config_dir = (source)

Undocumented

copyright: str = (source)

Undocumented

doctree_dir = (source)

Undocumented

fresh_env: bool = (source)

Undocumented

keep_going: bool = (source)

Undocumented

link_index: bool = (source)

Undocumented

nitpicky: bool = (source)

Undocumented

Undocumented

Undocumented

Undocumented

source_dir = (source)

Undocumented

Undocumented

traceback: bool = (source)

Undocumented

verbosity = (source)

Undocumented

Undocumented

warning_is_error: bool = (source)

Undocumented

def _guess_source_dir(self): (source)

Undocumented

Returns
strUndocumented