diff roundup/dist/command/build_doc.py @ 4033:bca7c59ac400

Enhance documentation generation.
author Stefan Seefeld <stefan@seefeld.name>
date Thu, 12 Feb 2009 05:54:26 +0000
parents
children 7b575e1f7368
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/roundup/dist/command/build_doc.py	Thu Feb 12 05:54:26 2009 +0000
@@ -0,0 +1,37 @@
+#
+# Copyright (C) 2009 Stefan Seefeld
+# All rights reserved.
+# For license terms see the file COPYING.txt.
+#
+
+import os, sys
+from stat import *
+import os.path
+from shutil import *
+import glob
+
+from distutils.command import build
+from distutils.spawn import spawn, find_executable
+from distutils.dep_util import newer, newer_group
+from distutils.dir_util import copy_tree, remove_tree, mkpath
+from distutils.file_util import copy_file
+from distutils import sysconfig
+
+class build_doc(build.build):
+    """Defines the specific procedure to build roundup's documentation."""
+
+    description = "build documentation"
+
+    def run(self):
+        """Run this command, i.e. do the actual document generation."""
+
+        sphinx = find_executable('sphinx-build')
+        if not sphinx:
+            self.warn("could not find sphinx-build in PATH")
+            self.warn("cannot build documentation")
+            return
+
+        doc_dir = os.path.join('share', 'doc', 'roundup', 'html')
+        temp_dir = os.path.join(self.build_temp, 'doc')
+        cmd = [sphinx, '-d', temp_dir, 'doc', doc_dir]
+        spawn(cmd)

Roundup Issue Tracker: http://roundup-tracker.org/