Changeset 1296

Timestamp:

05/22/07 02:28:29 (2 years ago)

Author:

arj..@yirdis.nl

Message:

Added build_doc target to gaphas' setup.py.
Epydoc should be installed in order to generate documentation.

Files:

• gaphas/trunk/epydoc.conf (added)
• gaphas/trunk/setup.py (modified) (2 diffs)

gaphas/trunk/setup.py

@@ -5 +5 @@
-
-from setuptools import setup, find_packages
+from distutils.cmd import Command
+
+class build_doc(Command):
+    description = 'Builds the documentation'
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        epydoc_conf = 'epydoc.conf'
+
+        try:
+            import sys
+            from epydoc import cli
+            old_argv = sys.argv[1:]
+            sys.argv[1:] = [
+                '--config=%s' % epydoc_conf,
+                '--no-private', # epydoc bug, not read from config
+                '--simple-term',
+                '--verbose'
+            ]
+            cli.cli()
+            sys.argv[1:] = old_argv
+
+        except ImportError:
+            print 'epydoc not installed, skipping API documentation.'
-
-setup(
@@ -58 +88 @@
-    test_suite = 'nose.collector',
-
+    cmdclass={'build_doc': build_doc },
-    )
-