Trees       Indices       Help   
kernel
Module DocGenerator
[hide private]
[frames] | no frames]

Module DocGenerator

source code

This is the documentation generator of the EDNA projet, it relies on EpyDoc, please have a look on the epydoc homepage

Date: 2011-04-13

Author: J\xc3\xa9r\xc3\xb4me Kieffer

Contact: Jerome.Kieffer@esrf.eu

Copyright: 2011-ESRF

License: GPLv3

Functions [hide private]
python dictionary
findPlugins(EDNAHome, EDPluginPrefix='EDPlugin', XSDataPrefix='XSData', pythonExtension='.py')
This function is the walker that goes through all directories in EDNA_HOME directory and searches for EDNA plugins ...		 source code
python list
findProjects(EDNAHome)
This function is the walker that goes through all directories in EDNA_HOME directory and searches for EDNA projects or libraries ...		 source code
python list
findFile(pluginDir, pythonExtension='.py', excludePrefixes=['XSData', 'dna_', 'ALJy', 'EDJob', 'EDParallelExecute', 'EDUt...)
This function is the walker that goes through all directories in plugin directory and searches for python source files ...		 source code
 
rmdir(topdir, bypass=False)
Delete everything reachable from the directory named in "top", assuming there are no symbolic links.		 source code
Variables [hide private]
  cwd = '/home/tester/tmpZRT10cdoc/Epydocv1_0-00000002'
  pyStrProgramPath = '/home/tester/tmpZRT10cdoc/Epydocv1_0-00000...
  pyStrBinPath = '/home/tester/tmpZRT10cdoc/Epydocv1_0-00000002'
  pyStrKernelPath = '/home/tester/tmpZRT10cdoc'
  pyStrEdnaHomePath = '/home/tester'
  strEdnaKernel = '/home/tester/kernel/src'
  dictJobs = {}
  __package__ = None
hash(x)
Function Details [hide private]

findPlugins(EDNAHome, EDPluginPrefix='EDPlugin', XSDataPrefix='XSData', pythonExtension='.py')

source code 

This function is the walker that goes through all directories in EDNA_HOME directory and searches for EDNA plugins ...

Parameters:
  • EDNAHome (string) - the path of EDNA_HOME
  • EDPluginPrefix (string) - the start of the name of an EDNA Plugin
  • pythonExtension (string) - the extension of an EDNA plugin, usually .py
Returns: python dictionary
to be definied but probably a dictionary with {EDPlugin: path}

findProjects(EDNAHome)

source code 

This function is the walker that goes through all directories in EDNA_HOME directory and searches for EDNA projects or libraries ...

Parameters:
  • EDNAHome (string) - the path of the EDNA_HOME top directory
  • EDPluginPrefix (string) - the start of the name of an EDNA Plugin
  • pythonExtension (string) - the extension of an EDNA plugin, usually .py
Returns: python list
a list of RelativeProjectPath

findFile(pluginDir, pythonExtension='.py', excludePrefixes=['XSData', 'dna_', 'ALJy', 'EDJob', 'EDParallelExecute', 'EDUt...)

source code 

This function is the walker that goes through all directories in plugin directory and searches for python source files ...

Parameters:
  • pluginDir (string) - the path to the plugin
  • pythonExtension (string) - the extension of an EDNA plugin, usually .py
  • excludePrefix (python string) - prefix that will not be included in code generation, typically the XSData bindings
Returns: python list
list of python files

rmdir(topdir, bypass=False)

source code 

Delete everything reachable from the directory named in "top", assuming there are no symbolic links. CAUTION: This is dangerous! For example, if top == '/', it could delete all your disk files.

Parameters:
  • topdir (python string) - the directory to remove, the directory will stay there, but emptied.
  • bypass (boolean) - bypass the security if True

Variables Details [hide private]

pyStrProgramPath

Value:
'/home/tester/tmpZRT10cdoc/Epydocv1_0-00000002/(imported)'

   Trees       Indices       Help   
kernel
Generated by Epydoc 3.0.1 on Fri Jun 20 03:53:30 2014 http://epydoc.sourceforge.net