F2x.distutils.command.build_sphinx module

class F2x.distutils.command.build_sphinx.build_sphinx(dist)

Bases: sphinx.setup_command.BuildDoc

Build documentation based on Sphinx.

This implementation adds automatic generation of the API documentation (sphinx-apidoc ...) during the build.

run()

A command’s raison d’etre: carry out the action it exists to perform, controlled by the options initialized in ‘initialize_options()’, customized by other commands, the setup script, the command-line, and config files, and finalized in ‘finalize_options()’. All terminal output and filesystem interaction should be done by ‘run()’.

This method must be implemented by all command classes.

use_f2x_template = False

F2x.distutils.command.build_sphinx.document_templates(source_dir)

Write a Sphinx documentation file for each template (including dependencies).

Parameters

source_dir – Base directory to write output to.