PyXMake Developer Guide 1.0
PyXMake
Loading...
Searching...
No Matches
PyXMake.Build.Make.Sphinx Class Reference

Base class for all Sphinx build events. More...

Inheritance diagram for PyXMake.Build.Make.Sphinx:
PyXMake.Build.Make.Make PyXMake.Tools.Utility.AbstractBase

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 Settings (self, **kwargs)
 
 parse (cls, **kwargs)
 
 create (self, **kwargs)
 
- Public Member Functions inherited from PyXMake.Build.Make.Make
 __posix__ (self, **kwargs)
 
 AddIncludePath (self, includes)
 
 AddDependencyPath (self, dependencies)
 
 UseLibraries (self, libs)
 
 SourcePath (self, path)
 
 OutputPath (self, path, files="")
 
 Environment (self, path, script="ifortvars.bat")
 
 Preprocessing (self, cmdstring='', inend='', outend='', copyfiles=[], replace={'!DEC$ IF':'#IF','!DEC$ ELSE':'#ELSE','!DEC$ ENDIF':'#ENDIF'})
 
 Build (self, cmdstring, **kwargs)
 
 Postprocessing (self, cmdstring='')
 
 run (cls, **kwargs)
 
- Public Member Functions inherited from PyXMake.Tools.Utility.AbstractBase
 __new__ (cls, *args, **kwargs)
 
 recover (cls, *args)
 
 classify (cls, *args, **kwargs)
 
 jsonify (self)
 
 update (self, **kwargs)
 
 __repr__ (self)
 
 __str__ (self)
 
 __getstate__ (self)
 
 __setstate__ (self, _dict)
 

Public Attributes

str MakeObjectKind = 'Sphinx'
 String identifier of current instance.
 
 path2exe = os.path.join(os.path.dirname(sys.executable),"Scripts")
 Path to Sphinx executable.
 
str exe = 'sphinx-build.exe'
 Executable of Sphinx.
 
 BuildOption = OrderedDict()
 Ordered dictionary containing all available options.
 
list incdirs = []
 Blank version of list containing library directories without initially specifying MKL.
 
list libdirs = []
 
 SPHINXOPTS = os.getenv('sphinx_opts', '')
 
 SPHINXBUILD = os.getenv('sphinx_build', 'sphinx-build')
 
 PAPER = os.getenv('sphinx_paper', None)
 
 SOURCEDIR = os.getenv('sphinx_sourcedir', self.srcdir)
 
 BUILDDIR = os.getenv('sphinx_builddir', Utility.PathLeaf(tempfile.NamedTemporaryFile().name))
 
 TEMPDIR = os.getenv('sphinx_templates', "_templates")
 
 STATICEDIR = os.getenv('sphinx_static', "_static")
 
 verbose
 
 scrtdir
 
 outdir
 
- Public Attributes inherited from PyXMake.Build.Make.Make
 buildid = BuildID
 Base string of build object.
 
list srcs = []
 Source file or folders.
 
list bare = not BuildID and not self.srcs
 
 stype = kwargs.get("stype",'Fortran')
 Source file type.
 
 verbose = verbose
 Level of verbosity of the current build object.
 
 hasFoss = kwargs.get("foss", Utility.GetExecutable("choco") or Utility.GetPlatform() in ["linux"] or kwargs.get("bash",False))
 Toggle between free open source software and commercial 3rd party libraries.
 
 scrtdir = os.getcwd()
 Current scratch directory

 
 srcdir = os.getcwd()
 Default search directory for source files.
 
 outdir = os.getcwd()
 Default search directory for output.
 
_, self.intelpath, self.iniCompiler intelpath = content
 Path to Intel Fortran Compiler (read from Paths.log or empty).
 
tuple temps = ()
 Tuple of data to be removed after job completion.
 
list incdirs = []
 List of include directories.
 
list libdirs = []
 List of library directories.
 
list libs = []
 List of actual libraries (by name) used during linking.
 
list copyfiles = []
 List of files to be copied to the output directory after finish.
 
str iniCompiler = ""
 Default initialization of compiler script.
 
bool setarch = True if kwargs.get('arch', None) in ['x86', 'x64'] else False
 Define the architecture for the build directly by using the keyword argument "arch".
 
 msvsc = kwargs.get("msvsc",'vs2015')
 Default version of Microsoft visual studio used by the Intel Fortran Compiler.
 
str architecture = 'x86'
 Processor architecture.
 
str postcmd = ""
 Post build command.
 
 buildname = self.temps + (inputfile, )
 
str precmd = self.iniCompiler+" "+cmdstring
 Command executed during pre-build event.
 
 compargs = cmdstring
 Command line arguments passed in by the user.
 
str makecmd = self.iniCompiler+" "+os.path.join(self.path2exe,self.exe)+" "+ cmd + cmdstring
 Command executed during build event.
 
 mkl_dependency
 

Additional Inherited Members

- Static Public Member Functions inherited from PyXMake.Build.Make.Make
 __parser__ ()
 
 Detach ()
 
 F2CPreprocessing (PreprocessingFile)
 
 sanitize (string, **kwargs)
 
 setup (*args, **kwargs)
 
- Static Public Member Functions inherited from PyXMake.Tools.Utility.AbstractBase
 __getbase__ (base, cls)
 
- Protected Attributes inherited from PyXMake.Build.Make.Make
list _mkl_includes = [x for x in self.incdirs if "mkl" in x]
 

Detailed Description

Base class for all Sphinx build events.

Inherited class to automatically build a documentation using Sphinx.

Inherited from Make.

Constructor & Destructor Documentation

◆ __init__()

PyXMake.Build.Make.Sphinx.__init__ ( self,
* args,
** kwargs )
Initialization of sphinx class object.

Reimplemented from PyXMake.Build.Make.Make.

Definition at line 3770 of file Make.py.

Member Function Documentation

◆ create()

PyXMake.Build.Make.Sphinx.create ( self,
** kwargs )
Execute make command

Reimplemented from PyXMake.Build.Make.Make.

Definition at line 3889 of file Make.py.

◆ parse()

PyXMake.Build.Make.Sphinx.parse ( cls,
** kwargs )
Execute the current class as a CLI command.

Definition at line 3821 of file Make.py.

◆ Settings()

PyXMake.Build.Make.Sphinx.Settings ( self,
** kwargs )
Define environment variables for the default configuration file.

Definition at line 3810 of file Make.py.

Member Data Documentation

◆ BUILDDIR

PyXMake.Build.Make.Sphinx.BUILDDIR = os.getenv('sphinx_builddir', Utility.PathLeaf(tempfile.NamedTemporaryFile().name))

Definition at line 3901 of file Make.py.

◆ BuildOption

PyXMake.Build.Make.Sphinx.BuildOption = OrderedDict()

Ordered dictionary containing all available options.

Definition at line 3792 of file Make.py.

◆ exe

str PyXMake.Build.Make.Sphinx.exe = 'sphinx-build.exe'

Executable of Sphinx.

Definition at line 3790 of file Make.py.

◆ incdirs

list PyXMake.Build.Make.Sphinx.incdirs = []

Blank version of list containing library directories without initially specifying MKL.


Definition at line 3806 of file Make.py.

◆ libdirs

list PyXMake.Build.Make.Sphinx.libdirs = []

Definition at line 3807 of file Make.py.

◆ MakeObjectKind

str PyXMake.Build.Make.Sphinx.MakeObjectKind = 'Sphinx'

String identifier of current instance.


Definition at line 3776 of file Make.py.

◆ outdir

PyXMake.Build.Make.Sphinx.outdir

Definition at line 4203 of file Make.py.

◆ PAPER

PyXMake.Build.Make.Sphinx.PAPER = os.getenv('sphinx_paper', None)

Definition at line 3898 of file Make.py.

◆ path2exe

PyXMake.Build.Make.Sphinx.path2exe = os.path.join(os.path.dirname(sys.executable),"Scripts")

Path to Sphinx executable.

Definition at line 3788 of file Make.py.

◆ scrtdir

PyXMake.Build.Make.Sphinx.scrtdir

Definition at line 4175 of file Make.py.

◆ SOURCEDIR

PyXMake.Build.Make.Sphinx.SOURCEDIR = os.getenv('sphinx_sourcedir', self.srcdir)

Definition at line 3900 of file Make.py.

◆ SPHINXBUILD

PyXMake.Build.Make.Sphinx.SPHINXBUILD = os.getenv('sphinx_build', 'sphinx-build')

Definition at line 3897 of file Make.py.

◆ SPHINXOPTS

PyXMake.Build.Make.Sphinx.SPHINXOPTS = os.getenv('sphinx_opts', '')

Definition at line 3896 of file Make.py.

◆ STATICEDIR

PyXMake.Build.Make.Sphinx.STATICEDIR = os.getenv('sphinx_static', "_static")

Definition at line 3903 of file Make.py.

◆ TEMPDIR

PyXMake.Build.Make.Sphinx.TEMPDIR = os.getenv('sphinx_templates', "_templates")

Definition at line 3902 of file Make.py.

◆ verbose

PyXMake.Build.Make.Sphinx.verbose

Definition at line 3948 of file Make.py.


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