viff

changeset 1308:85fd0fbfdb5a

find changesets by author, revision, files, or words in the commit message
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 diff
     1.1 --- a/MANIFEST.in	Mon Oct 19 16:41:31 2009 +0200
     1.2 +++ b/MANIFEST.in	Mon Oct 19 17:02:50 2009 +0200
     1.3 @@ -1,5 +1,4 @@
     1.4  graft doc/api
     1.5 -exclude epydoc.conf
     1.6  
     1.7  graft doc/html
     1.8  prune doc/html/.doctrees

     2.1 --- a/doc/conf.py	Mon Oct 19 16:41:31 2009 +0200
     2.2 +++ b/doc/conf.py	Mon Oct 19 17:02:50 2009 +0200
     2.3 @@ -63,7 +63,7 @@
     2.4  today_fmt = '%B %d, %Y'
     2.5  
     2.6  # List of documents that shouldn't be included in the build.
     2.7 -unused_docs = ['api/api-objects'] # Generated by epydoc.
     2.8 +unused_docs = []
     2.9  
    2.10  # If true, '()' will be appended to :func: etc. cross-reference text.
    2.11  #add_function_parentheses = True

     3.1 --- a/epydoc.conf	Mon Oct 19 16:41:31 2009 +0200
     3.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.3 @@ -1,15 +0,0 @@
     3.4 -[epydoc]
     3.5 -
     3.6 -name: VIFF: Virtual Ideal Functionality Framework
     3.7 -url: http://viff.dk/
     3.8 -
     3.9 -modules: viff
    3.10 -exclude: test, libs
    3.11 -
    3.12 -output: html
    3.13 -target: doc/api
    3.14 -
    3.15 -graph: classtree
    3.16 -include-log: yes
    3.17 -
    3.18 -external-api: mod, func, data, const, class, exc, meth, attr, exc, file, envvar

     4.1 --- a/run.py	Mon Oct 19 16:41:31 2009 +0200
     4.2 +++ b/run.py	Mon Oct 19 17:02:50 2009 +0200
     4.3 @@ -105,11 +105,6 @@
     4.4          shutil.rmtree('doc/html')
     4.5      sphinx('doc/html')
     4.6  
     4.7 -    # Generate API docs in doc/api.
     4.8 -    if isdir('doc/api'):
     4.9 -        shutil.rmtree('doc/api')
    4.10 -    epydoc('doc/api')
    4.11 -
    4.12      # Pack everything up with Distutils.
    4.13      execute(["python", "setup.py", "sdist", "--force-manifest",
    4.14               "--formats=bztar,gztar,zip"])
    4.15 @@ -117,13 +112,6 @@
    4.16      # Generate binary Windows installer (which has no docs, though).
    4.17      execute(["python", "setup.py", "bdist", "--formats=wininst"])
    4.18  
    4.19 -@command('epydoc', 'target')
    4.20 -def epydoc(target):
    4.21 -    """Generate API documentation using epydoc."""
    4.22 -    ensure_dir(target)
    4.23 -    execute(["epydoc", "-vv", "--config", "epydoc.conf"],
    4.24 -            {'VIFF_NO_WRAP': 'YES', 'target': target})
    4.25 -
    4.26  @command('sphinx', 'target')
    4.27  def sphinx(target):
    4.28      """Generate VIFF manual using Sphinx."""