PyXMake Developer Guide 1.0
PyXMake
Loading...
Searching...
No Matches
PyXMake.VTL.stm_make.doxy_pyxmake Class Reference
Inheritance diagram for PyXMake.VTL.stm_make.doxy_pyxmake:
PyXMake.VTL.stm_make.pyx_doxygen PyXMake.VTL.stm_make._BaseCommandRunner

Public Attributes

str brief = "PyXMake"
 
str header = "PyXMake Developer Guide"
 
- Public Attributes inherited from PyXMake.VTL.stm_make.pyx_doxygen
int verbose = 0
 
str source_path = ''
 
str output_file_path = ''
 
str stype = "Fortran"
 
 scratch_path = os.getcwd()
 
- Public Attributes inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 verbose
 

Protected Member Functions

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

Protected Attributes

list _INPUT_FILES = [x[0] for x in Utility.PathWalk(self.source_path, startswith=(".","__"), contains=("doc","bin","config"), endswith=("make","scratch"))]
 

Static Protected Attributes

str _BUILD_NAME = 'pyx_core'
 
- Static Protected Attributes inherited from PyXMake.VTL.stm_make.pyx_doxygen
str _BUILD_NAME = ''
 
list _INPUT_FILES = []
 

Additional Inherited Members

- Public Member Functions inherited from PyXMake.VTL.stm_make.pyx_doxygen
 initialize_options (self)
 
 finalize_options (self)
 
- Public Member Functions inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 run (self)
 
- Static Public Attributes inherited from PyXMake.VTL.stm_make.pyx_doxygen
str description = "Runs the html documentation build process of source code using Doxygen."
 
list user_options
 
- Static Protected Member Functions inherited from PyXMake.VTL.stm_make._BaseCommandRunner
 _create_build_dir ()
 

Detailed Description

Runs the html documentation build process for PyXMake. 

Definition at line 428 of file stm_make.py.

Member Function Documentation

◆ _create_command()

PyXMake.VTL.stm_make.doxy_pyxmake._create_command ( self)
protected

Reimplemented from PyXMake.VTL.stm_make._BaseCommandRunner.

Definition at line 444 of file stm_make.py.

Member Data Documentation

◆ _BUILD_NAME

str PyXMake.VTL.stm_make.doxy_pyxmake._BUILD_NAME = 'pyx_core'
staticprotected

Definition at line 433 of file stm_make.py.

◆ _INPUT_FILES

list PyXMake.VTL.stm_make.doxy_pyxmake._INPUT_FILES = [x[0] for x in Utility.PathWalk(self.source_path, startswith=(".","__"), contains=("doc","bin","config"), endswith=("make","scratch"))]
protected

Definition at line 447 of file stm_make.py.

◆ brief

str PyXMake.VTL.stm_make.doxy_pyxmake.brief = "PyXMake"

Definition at line 449 of file stm_make.py.

◆ header

str PyXMake.VTL.stm_make.doxy_pyxmake.header = "PyXMake Developer Guide"

Definition at line 450 of file stm_make.py.


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