| | |
- IASApiDocs.DocGenerator.DocGenerator(builtins.object)
-
- PydocBuilder
class PydocBuilder(IASApiDocs.DocGenerator.DocGenerator) |
| |
PydocBuilder(srcFolder, dstFolder, includeTestFolder=False, outFile=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)
Builds python API documentation, delegating to pydoc
|
| |
- Method resolution order:
- PydocBuilder
- IASApiDocs.DocGenerator.DocGenerator
- builtins.object
Methods defined here:
- __init__(self, srcFolder, dstFolder, includeTestFolder=False, outFile=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)
- Constructor
@param srcFolder: the folder with python sources to generate their documentation
@param dstFolder: destination folder for pydocs
@param includeTestFolder: True if the class must generate documentation for the python
sources in test folders (defaults to False)
@param outFile: the file where the output generated by calling pydoc must be sent
- buildIndex(self, folder)
- Build the index.thm file needed by github web server.
The index will simply list the generated html files
@param folder: the folder containing html files to index
- buildPydocs(self)
- Build the pydocs
Generation of pydocs is delegated to pydoc executable
@return: the code returned by calling pydoc
- getPythonFilesInFolder(self, folder)
- Get the python sources in the passed folder
Note that these files are python scripts that do not belong
to a python module
Methods inherited from IASApiDocs.DocGenerator.DocGenerator:
- checkFolders(self, src, dst)
- Check if the source and dest folders are valid and if it is not the case,
throws an exception
@param src: the folder with java sources to check
@param dst: destination folder to check
- containsSources(self, folder, fileExtension)
- @param folder: the folder (src or test) to check if contains java sources
@param fileExtension: the extension of the files that the folder is supposed to contain
@return: True if the passed folder contains java sources
- getSrcPaths(self, sourceFolder, includeTestFolder, folderName, fileExtension)
- Scan the source folder and return a list of source folders
containing source files.
Source can be contained into src or test (the latter is used only
if the includeTestFolder parameter is True)
The search is recursive because a folder can contain several modules
@param sourceFolder: root source folder (generally IAS, passed in the command line)
@param includeTestFolder: True to include test folders in the scan
@param folderName: the name of the folder containing the sources like java or python
@param fileExtension: the extension of the files that the folder is supposed to contain
Data descriptors inherited from IASApiDocs.DocGenerator.DocGenerator:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
| |