remove epydoc from the repo

.travis.yml

@@ -23,13 +23,6 @@ before_install:
   - export PATH=/home/travis/miniconda2/bin:$PATH
   - conda update --yes conda
 
-# Install Epydoc
-  - wget -q http://prdownloads.sourceforge.net/epydoc/epydoc-3.0.1.tar.gz
-  - gunzip epydoc-3.0.1.tar.gz
-  - tar -xvf epydoc-3.0.1.tar
-  - cd epydoc-3.0.1/
-  - sudo make install
-
 install:
   - if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then conda create --yes -q -n pyenv mkl python=2.6 numpy=1.7.1 scipy=0.11 nose=1.3.0 pyparsing=1.5 pip flake8=2.3 six=1.9.0 pep8=1.6.2 pyflakes=0.8.1; fi
   - if [[ $TRAVIS_PYTHON_VERSION == '3.3' ]]; then conda create --yes -q -n pyenv mkl python=3.3 numpy=1.9.1 scipy=0.14.0 nose=1.3.4 pyparsing=1.5 pip flake8=2.3 six=1.9.0 pep8=1.6.2 pyflakes=0.8.1; fi

README.txt

@@ -2,7 +2,6 @@ To install the package, see this page:
 
    http://deeplearning.net/software/theano/install.html
 
-
 For the documentation, see the project website:
 
    http://deeplearning.net/software/theano/
@@ -14,7 +13,7 @@ Related Projects:
 We recommend you look at the documentation on the website, since it
 will be more current than the documentation included with the package.
 If you really wish to build the documentation yourself, you will need
-epydoc and sphinx. Issue the following command:
+sphinx. Issue the following command:
 
     python ./doc/scripts/docgen.py
 

doc/api/epydoc.conf

-# TODO:
-#   Get all graphs to work!
-
-
-[epydoc] # Epydoc section marker (required by ConfigParser)
-
-# The list of objects to document.  Objects can be named using
-# dotted names, module filenames, or package directory names.
-# Alases for this option include "objects" and "values".
-modules: theano scipy.sparse
-
-# The type of output that should be generated.  Should be one
-# of: html, text, latex, dvi, ps, pdf.
-output: html
-
-# An integer indicating how verbose epydoc should be.  The default
-# 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
-# in case of unexpected error. By default don't show tracebacks
-debug: 1
-
-# 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
-# external-api: wiki doc
-# external-api-root: wiki:http://lgcm.iro.umontreal.ca/theano/wiki/ doc:http://lgcm.iro.umontreal.ca/auto_theano/doc/
-# external-api-file: wiki:wiki.idx doc:doc/doc.idx
-
-### 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

doc/dev_start_guide.txt

@@ -21,12 +21,11 @@ To get up to speed, you'll need to
 - Learn some non-basic Python to understand what's going on in some of the
   trickier files (like tensor.py).
 - Go through the `NumPy documentation`_.
-- Learn to write reStructuredText_ for epydoc_ and Sphinx_.
+- Learn to write reStructuredText_ for Sphinx_.
 - Learn about how unittest_ and nose_ work
 
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
-.. _epydoc: http://epydoc.sourceforge.net/
 .. _NumPy documentation: http://docs.scipy.org/numpy/
 .. _unittest: http://docs.python.org/library/unittest.html
 .. _nose: http://somethingaboutorange.com/mrl/projects/nose/

doc/install.txt

@@ -886,7 +886,7 @@ We recommend you look at the documentation on the website, since it
 will be more current than the documentation included with the package.
 
 If you really wish to build the documentation yourself, you will need
-epydoc and sphinx, as described above. Issue the following command::
+sphinx, as described above. Issue the following command::
 
     python ./doc/scripts/docgen.py
 

doc/internal/metadocumentation.txt

@@ -40,8 +40,8 @@ Use ReST for documentation
 --------------------------
 
  * `ReST <http://docutils.sourceforge.net/rst.html>`__ is standardized.
-   epydoc is not. trac wiki-markup is not.
-   This means that ReST can be cut-and-pasted between epydoc, code, other
+   trac wiki-markup is not.
+   This means that ReST can be cut-and-pasted between code, other
    docs, and TRAC.  This is a huge win!
  * ReST is extensible: we can write our own roles and directives to automatically link to WIKI, for example.
  * ReST has figure and table directives, and can be converted (using a standard tool) to latex documents.

doc/scripts/docgen.py

@@ -4,56 +4,6 @@ import sys
 import os
 import shutil
 import inspect
-
-from epydoc import docintrospecter
-from epydoc.apidoc import RoutineDoc
-
-
-def Op_to_RoutineDoc(op, routine_doc, module_name=None):
-    routine_doc.specialize_to(RoutineDoc)
-
-    #NB: this code is lifted from epydoc/docintrospecter.py
-
-    # op should be an op instance
-    assert hasattr(op, 'perform')
-
-    # Record the function's docstring.
-    routine_doc.docstring = getattr(op, '__doc__', '')
-
-    # Record the function's signature.
-    func = op.__epydoc_asRoutine
-    if isinstance(func, type(Op_to_RoutineDoc)):
-        (args, vararg, kwarg, defaults) = inspect.getargspec(func)
-
-        # Add the arguments.
-        routine_doc.posargs = args
-        routine_doc.vararg = vararg
-        routine_doc.kwarg = kwarg
-
-        # Set default values for positional arguments.
-        routine_doc.posarg_defaults = [None] * len(args)
-
-        # Set the routine's line number.
-        if hasattr(func, '__code__'):
-            routine_doc.lineno = func.__code__.co_firstlineno
-    else:
-        # [XX] I should probably use UNKNOWN here??
-        # dvarrazzo: if '...' is to be changed, also check that
-        # `docstringparser.process_arg_field()` works correctly.
-        # See SF bug #1556024.
-        routine_doc.posargs = ['...']
-        routine_doc.posarg_defaults = [None]
-        routine_doc.kwarg = None
-        routine_doc.vararg = None
-
-    return routine_doc
-
-docintrospecter.register_introspecter(
-    lambda value: getattr(value, '__epydoc_asRoutine', False),
-    Op_to_RoutineDoc,
-    priority=-1)
-
-
 import getopt
 from collections import defaultdict
 
@@ -66,7 +16,7 @@ if __name__ == '__main__':
     opts, args = getopt.getopt(
         sys.argv[1:],
         'o:f:',
-        ['epydoc', 'rst', 'help', 'nopdf', 'cache', 'test'])
+        ['rst', 'help', 'nopdf', 'cache', 'test'])
     options.update(dict([x, y or True] for x, y in opts))
     if options['--help']:
         print('Usage: %s [OPTIONS] [files...]' % sys.argv[0])
@@ -74,8 +24,6 @@ if __name__ == '__main__':
         print('  --cache: use the doctree cache')
         print('  --rst: only compile the doc (requires sphinx)')
         print('  --nopdf: do not produce a PDF file from the doc, only HTML')
-        print('  --epydoc: only compile the api documentation', end=' ')
-        print('(requires epydoc)')
         print('  --test: run all the code samples in the documentaton')
         print('  --help: this help')
         print('If one or more files are specified after the options then only '
@@ -83,7 +31,7 @@ if __name__ == '__main__':
               'processed. Specifying files will implies --cache.')
         sys.exit(0)
 
-    if not (options['--epydoc'] or options['--rst'] or options['--test']):
+    if options['--rst'] or options['--test']:
         # Default is now rst
         options['--rst'] = True
 
@@ -105,8 +53,8 @@ if __name__ == '__main__':
     pythonpath = os.pathsep.join([throot, pythonpath])
     sys.path[0:0] = [throot]  # We must not use os.environ.
 
-    if options['--all'] or options['--epydoc']:
-        mkdir("api")
+    # if options['--all']:
+    #     mkdir("api")
 
         #Generate HTML doc
 
@@ -116,7 +64,7 @@ if __name__ == '__main__':
         #               '-o', 'api']
         #cli()
         ## So we use this instead
-        os.system("epydoc --config %s/doc/api/epydoc.conf -o api" % throot)
+        #os.system("epydoc --config %s/doc/api/epydoc.conf -o api" % throot)
 
         # Generate PDF doc
         # TODO