6Triple-use minimum working example for PyXMake. This script can be
7executed in three different ways in varying levels of accessibility
9@note: Create documentations for PyXMake, PyCODAC and STMLab with Sphinx.
13----------------------------------------------------------------------------------------------
20@author: garb_ma [DLR-FA,STM Braunschweig]
21----------------------------------------------------------------------------------------------
29 sys.path.insert(0,os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))))
33 from PyXMake
import VTL
36__arch = Utility.GetArchitecture()
37__platform = Utility.GetPlatform()
41 from PyCODAC.Tools.Utility
import GetPyCODACPath
43 __pyc_core_path = GetPyCODACPath()
56 source = os.path.join(__pyc_core_path,
"VTL",
"doc",
"mcd_legacy") ,
57 output= os.path.join(__pyc_core_path,
"VTL",
"doc",
"mcd_legacy"),
58 include=[os.path.join(__pyc_core_path),Utility.GetPyXMakePath()],
59 scratch=VTL.Scratch, verbosity=2,
62 Main function to execute the script.
65 SphinxBuild =
Sphinx(BuildID, masterfile, scratch=scratch, verbose=verbosity)
66 SphinxBuild .SourcePath(source)
67 SphinxBuild .AddIncludePath(include)
68 SphinxBuild.OutputPath(output)
69 SphinxBuild.Settings(**kwargs)
72if __name__ ==
'__main__':
79 print(
"==================================")
80 print(
"Finished build with Sphinx")
81 print(
"==================================")
Base class for all Sphinx build events.
Create a make object to define the building environment.
main(BuildID, masterfile, source=os.path.join(__pyc_core_path,"VTL","doc","mcd_legacy"), output=os.path.join(__pyc_core_path,"VTL","doc","mcd_legacy"), include=[os.path.join(__pyc_core_path), Utility.GetPyXMakePath()], scratch=VTL.Scratch, verbosity=2, **kwargs)