demcompare.sphinx_project_generator

sphinx_project_generator was built for demcompare and its ‘report’ step. As so, it is designed for this simple purpose, meaning only light version of the Makefile and the conf.py are proposed, and no way to control them. If somehow required, this project generator shall be improved to offer some level of customization.

Module Contents

Classes

SphinxProjectManager

Sphinx Projet Manager Class

Attributes

SPM

class demcompare.sphinx_project_generator.SphinxProjectManager(working_dir, output_dir, index_name, project_name)[source]

Sphinx Projet Manager Class Class to represent the Sphinx demcompare report and be able to ease its manipulation: create a sphinx project architecture + configuration + build and install project

_create_sphinx_project()[source]

Create project architecture and configuration :

_working_dir/build/ _working_dir/Makefile _working_dir/source/ _working_dir/source/conf.py _working_dir/source/_index_name.rst

Returns:

_create_makefile()[source]
_create_confpy()[source]
write_body(body)[source]

Write report body in class file.

Parameters:

body – body text

build_project(mode)[source]

Build project depending on mode.

Parameters:

mode – ‘html’ or ‘latex’ or ‘latexpdf’

Returns:

install_project()[source]

Method to install (copy from build) sphinx project in _output_dir

static clean()[source]
demcompare.sphinx_project_generator.SPM[source]