now epydoc is a documentation driver script

469c90d2 · projects@lgcm · 8c8c4b6e · 469c90d2
--- a/epydoc
+++ b/epydoc
-# TODO:
+#!/usr/bin/python
-#   Get all graphs to work!
+#
+# Call the command line interface for Epydoc.
+#
+# Make sure that we don't get confused between an epydoc.py script and
+# the real epydoc package.
+import sys, os.path
+if os.path.exists(os.path.join(sys.path[0], 'epydoc.py')):
+    del sys.path[0]
-[epydoc] # Epydoc section marker (required by ConfigParser)
+from epydoc import docintrospecter 
+from epydoc.apidoc import RoutineDoc
-# The list of objects to document.  Objects can be named using
+from gof import Op
-# dotted names, module filenames, or package directory names.
-# Alases for this option include "objects" and "values".
-modules: *.py, gof/*.py, theano/*.py, theano/gof/*.py, joseph/*.py, pylearn/*.py, scipy, numpy
-# The type of output that should be generated.  Should be one
+def applicability_test(value):
-# of: html, text, latex, dvi, ps, pdf.
+   if 'elemwise.Elemwise object' in str(value):
-output: html
+       print value.__name__
+       return True
+   return False # isinstance(value, float)
-# The path to the output directory.  May be relative or absolute.
+def introspecter(value, value_doc, module_name):
-target: html/
+    print value
+    try:
+        value_doc.specialize_to(RoutineDoc)
+        print 'Yay!', value
+    except:
+	print value
-# An integer indicating how verbose epydoc should be.  The default
+docintrospecter.register_introspecter(applicability_test, introspecter, priority=-1)
-# value is 0; negative values will supress warnings and errors;
-# positive values will give more verbose output.
-verbosity: 1
-# A boolean value indicating that Epydoc should show a tracaback
+from epydoc.cli import cli
-# in case of unexpected error. By default don't show tracebacks
+cli()
-debug: 0
-# If True, don't try to use colors or cursor control when doing
-# textual output. The default False assumes a rich text prompt
-simple-term: 0
-### Generation options
-# The default markup language for docstrings, for modules that do
-# not define __docformat__.  Defaults to epytext.
-docformat: epytext
-# Whether or not parsing should be used to examine objects.
-parse: yes
-# Whether or not introspection should be used to examine objects.
-introspect: yes
-# Don't examine in any way the modules whose dotted name match this
-# regular expression pattern.
-#exclude
-# Don't perform introspection on the modules whose dotted name match this
-# regular expression pattern.
-#exclude-introspect
-# Don't perform parsing on the modules whose dotted name match this
-# regular expression pattern.
-#exclude-parse
-# The format for showing inheritance objects.
-# It should be one of: 'grouped', 'listed', 'included'.
-inheritance: grouped
-# Whether or not to inclue private variables.  (Even if included,
-# private variables will be hidden by default.)
-private: yes
-# Whether or not to list each module's imports.
-imports: yes
-# Whether or not to include syntax highlighted source code in
-# the output (HTML only).
-sourcecode: yes
-# Whether or not to includea a page with Epydoc log, containing
-# effective option at the time of generation and the reported logs.
-include-log: yes
-### Output options
-# The documented project's name.
-name: Theano
-# The CSS stylesheet for HTML output.  Can be the name of a builtin
-# stylesheet, or the name of a file.
-css: white
-# The documented project's URL.
-url: http://lgcm.iro.umontreal.ca/theano/
-# HTML code for the project link in the navigation bar.  If left
-# unspecified, the project link will be generated based on the
-# project's name and URL.
-#link: <a href="somewhere">My Cool Project</a>
-# The "top" page for the documentation.  Can be a URL, the name
-# of a module or class, or one of the special names "trees.html",
-# "indices.html", or "help.html"
-#top: os.path
-# An alternative help file.  The named file should contain the
-# body of an HTML file; navigation bars will be added to it.
-#help: my_helpfile.html
-# Whether or not to include a frames-based table of contents.
-#frames: yes
-frames: no
-# Whether each class should be listed in its own section when
-# generating LaTeX or PDF output.
-separate-classes: no
-### API linking options
-# Define a new API document.  A new interpreted text role
-# will be created
-#external-api: epydoc
-# Use the records in this file to resolve objects in the API named NAME.
-#external-api-file: epydoc:api-objects.txt
-# Use this URL prefix to configure the string returned for external API.
-#external-api-root: epydoc:http://epydoc.sourceforge.net/api
-### Graph options
-# The list of graph types that should be automatically included
-# in the output.  Graphs are generated using the Graphviz "dot"
-# executable.  Graph types include: "classtree", "callgraph",
-# "umlclass".  Use "all" to include all graph types
-graph: all
-# The path to the Graphviz "dot" executable, used to generate
-# graphs.
-dotpath: /usr/bin/dot
-# The name of one or more pstat files (generated by the profile
-# or hotshot module).  These are used to generate call graphs.
-pstat: autotest.pstat
-# Specify the font used to generate Graphviz graphs.
-# (e.g., helvetica or times).
-graph-font: Helvetica
-# Specify the font size used to generate Graphviz graphs.
-graph-font-size: 10
-### Return value options
-# The condition upon which Epydoc should exit with a non-zero
-# exit status. Possible values are error, warning, docstring_warning
-#fail-on: error