PyXMake Developer Guide  1.0
PyXMake
PyXMake.VTL.stm_make.pyx_sphinx Class Reference
Inheritance diagram for PyXMake.VTL.stm_make.pyx_sphinx:
PyXMake.VTL.stm_make._BaseCommandRunner PyXMake.VTL.stm_make.sphinx_stmlab

Public Member Functions

def initialize_options (self)
 
def finalize_options (self)
 
- Public Member Functions inherited from PyXMake.VTL.stm_make._BaseCommandRunner
def run (self)
 

Public Attributes

 verbose
 
 include_path
 
 source_path
 
 output_file_path
 
 scratch_path
 
 logo
 

Static Public Attributes

string description = "Runs the html documentation build process of source code using Sphinx."
 
list user_options
 

Detailed Description

Base class for encapsulating command line arguments and build process. 

Definition at line 267 of file stm_make.py.

Member Function Documentation

◆ finalize_options()

def PyXMake.VTL.stm_make.pyx_sphinx.finalize_options (   self)
Post-process options.

Definition at line 297 of file stm_make.py.

◆ initialize_options()

def PyXMake.VTL.stm_make.pyx_sphinx.initialize_options (   self)
Set default values for options.

Definition at line 285 of file stm_make.py.

Member Data Documentation

◆ user_options

list PyXMake.VTL.stm_make.pyx_sphinx.user_options
static
Initial value:
= [
# The format is (long option, short option, description).
('source-path=', None, 'path to the folder holding source files'),
('verbose=', None, 'controls the logging level (0 - Nothing, 2- Everything) Default: 0 - Nothing'),
('include-path=', None, 'path to additional files required for processing.'),
('scratch-path=', None, 'path to scratch folder where all temporary data is located during the build event'),
('output-file-path=', None, 'path to the output directory'),
('logo=', None, 'Custom logo for the upper left corner. Defaults to None, leaving the space empty'),
]

Definition at line 275 of file stm_make.py.


The documentation for this class was generated from the following file: