changeset 1308:85fd0fbfdb5a

remove support for Epydoc Trying to support both Sphinx and Epydoc with the same set of docstrings is silly since it means that we can only use a subset of the features of each. I'm therefore removing the Epydoc support since I like Sphinx better.
author Martin Geisler <mg@cs.au.dk>
date Mon, 19 Oct 2009 17:02:50 +0200
parents 8631a0070c7c
children 23b6edabac78
files MANIFEST.in doc/conf.py epydoc.conf run.py
diffstat 4 files changed, 1 insertions(+), 29 deletions(-) [+]
line wrap: on
line diff
--- a/MANIFEST.in	Mon Oct 19 16:41:31 2009 +0200
+++ b/MANIFEST.in	Mon Oct 19 17:02:50 2009 +0200
@@ -1,5 +1,4 @@
 graft doc/api
-exclude epydoc.conf
 
 graft doc/html
 prune doc/html/.doctrees
--- a/doc/conf.py	Mon Oct 19 16:41:31 2009 +0200
+++ b/doc/conf.py	Mon Oct 19 17:02:50 2009 +0200
@@ -63,7 +63,7 @@
 today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
-unused_docs = ['api/api-objects'] # Generated by epydoc.
+unused_docs = []
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True
--- a/epydoc.conf	Mon Oct 19 16:41:31 2009 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,15 +0,0 @@
-[epydoc]
-
-name: VIFF: Virtual Ideal Functionality Framework
-url: http://viff.dk/
-
-modules: viff
-exclude: test, libs
-
-output: html
-target: doc/api
-
-graph: classtree
-include-log: yes
-
-external-api: mod, func, data, const, class, exc, meth, attr, exc, file, envvar
--- a/run.py	Mon Oct 19 16:41:31 2009 +0200
+++ b/run.py	Mon Oct 19 17:02:50 2009 +0200
@@ -105,11 +105,6 @@
         shutil.rmtree('doc/html')
     sphinx('doc/html')
 
-    # Generate API docs in doc/api.
-    if isdir('doc/api'):
-        shutil.rmtree('doc/api')
-    epydoc('doc/api')
-
     # Pack everything up with Distutils.
     execute(["python", "setup.py", "sdist", "--force-manifest",
              "--formats=bztar,gztar,zip"])
@@ -117,13 +112,6 @@
     # Generate binary Windows installer (which has no docs, though).
     execute(["python", "setup.py", "bdist", "--formats=wininst"])
 
-@command('epydoc', 'target')
-def epydoc(target):
-    """Generate API documentation using epydoc."""
-    ensure_dir(target)
-    execute(["epydoc", "-vv", "--config", "epydoc.conf"],
-            {'VIFF_NO_WRAP': 'YES', 'target': target})
-
 @command('sphinx', 'target')
 def sphinx(target):
     """Generate VIFF manual using Sphinx."""