Package vdb :: Package tools :: Module gendocs
[hide private]
[frames] | no frames]

Module gendocs

source code


Generates HTML documentation for Vdb and related APIs using epydoc.

Command line options (all are optional):

    --dotpath=PATH          To generate class heirarchy graphs as part of
                            documentation, specify the path to the GraphViz
                            dot executable

    -o PATH, --output=PATH  The output directory.  If PATH does not exist,
                            then it will be created.  If it exists and is
                            non-empty, then the current directory will be
                            renamed and a new one created.

    NAMES...                If you have additional files / modules to be
                            included in the documentation, specify them on the
                            command line after other options.

Usage Examples: (from command prompt in directory containing vdb directory)
  python -m vdb.tools.gendocs
  python -m vdb.tools.gendocs --dotpath "D:\downloads\Graphviz 2.28\bin\dot.exe" ..\vdb-extensions-git\*.py
  python -m vdb.tools.gendocs --dotpath "D:\downloads\Graphviz 2.28\bin\dot.exe" --output mydocs ..\vdb-extensions-git\*.py

Functions [hide private]
 
vdbEpydoc()
Generates HTML documentation for Vdb and related APIs using epydoc.
source code