PyXMake Developer Guide 1.0
PyXMake
Loading...
Searching...
No Matches
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

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

Public Attributes

int verbose = 0
 
str include_path = ""
 
str source_path = ''
 
str output_file_path = ''
 
 scratch_path = os.getcwd()
 
 logo = None
 
- Public Attributes inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 verbose
 

Static Public Attributes

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

Protected Member Functions

 _run_command (self, command)
 
- Protected Member Functions inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 _create_command (self)
 
 _perform_post_actions (self)
 

Static Protected Attributes

str _BUILD_NAME = ''
 
str _INPUT_FILE = ""
 

Additional Inherited Members

- Static Protected Member Functions inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 _create_build_dir ()
 

Detailed Description

Base class for encapsulating command line arguments and build process. 

Definition at line 286 of file stm_make.py.

Member Function Documentation

◆ _run_command()

PyXMake.VTL.stm_make.pyx_sphinx._run_command ( self,
command )
protected
Execute build command

Reimplemented from PyXMake.VTL.stm_make._BaseCommandRunner.

Definition at line 324 of file stm_make.py.

◆ finalize_options()

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

Definition at line 316 of file stm_make.py.

◆ initialize_options()

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

Definition at line 304 of file stm_make.py.

Member Data Documentation

◆ _BUILD_NAME

PyXMake.VTL.stm_make.pyx_sphinx._BUILD_NAME = ''
staticprotected

Definition at line 290 of file stm_make.py.

◆ _INPUT_FILE

PyXMake.VTL.stm_make.pyx_sphinx._INPUT_FILE = ""
staticprotected

Definition at line 291 of file stm_make.py.

◆ description

str PyXMake.VTL.stm_make.pyx_sphinx.description = "Runs the html documentation build process of source code using Sphinx."
static

Definition at line 293 of file stm_make.py.

◆ include_path

str PyXMake.VTL.stm_make.pyx_sphinx.include_path = ""

Definition at line 310 of file stm_make.py.

◆ logo

PyXMake.VTL.stm_make.pyx_sphinx.logo = None

Definition at line 314 of file stm_make.py.

◆ output_file_path

str PyXMake.VTL.stm_make.pyx_sphinx.output_file_path = ''

Definition at line 312 of file stm_make.py.

◆ scratch_path

PyXMake.VTL.stm_make.pyx_sphinx.scratch_path = os.getcwd()

Definition at line 313 of file stm_make.py.

◆ source_path

PyXMake.VTL.stm_make.pyx_sphinx.source_path = ''

Definition at line 311 of file stm_make.py.

◆ 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 294 of file stm_make.py.

◆ verbose

int PyXMake.VTL.stm_make.pyx_sphinx.verbose = 0

Definition at line 309 of file stm_make.py.


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