changeset 118:3d9cb4beec8b

Moved doc config into a subdirectory, and added a `--force` option to the `build_doc` command.
author cmlenz
date Fri, 15 Jun 2007 18:27:38 +0000
parents 0b4796ed9426
children c84f629da9de
files doc/conf/docutils.ini doc/conf/epydoc.ini doc/docutils.conf doc/epydoc.conf setup.py
diffstat 3 files changed, 8 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
rename from doc/docutils.conf
rename to doc/conf/docutils.ini
rename from doc/epydoc.conf
rename to doc/conf/epydoc.ini
--- a/setup.py
+++ b/setup.py
@@ -26,12 +26,15 @@
 class build_doc(Command):
     description = 'Builds the documentation'
     user_options = [
+        ('force', None,
+         "force regeneration even if no reStructuredText files have changed"),
         ('without-apidocs', None,
          "whether to skip the generation of API documentaton"),
     ]
-    boolean_options = ['without-apidocs']
+    boolean_options = ['force', 'without-apidocs']
 
     def initialize_options(self):
+        self.force = False
         self.without_apidocs = False
 
     def finalize_options(self):
@@ -42,8 +45,8 @@
         from docutils.nodes import raw
         from docutils.parsers import rst
 
-        docutils_conf = os.path.join('doc', 'docutils.conf')
-        epydoc_conf = os.path.join('doc', 'epydoc.conf')
+        docutils_conf = os.path.join('doc', 'conf', 'docutils.ini')
+        epydoc_conf = os.path.join('doc', 'conf', 'epydoc.ini')
 
         try:
             from pygments import highlight
@@ -64,8 +67,8 @@
 
         for source in glob('doc/*.txt'):
             dest = os.path.splitext(source)[0] + '.html'
-            if not os.path.exists(dest) or \
-                   os.path.getmtime(dest) < os.path.getmtime(source):
+            if self.force or not os.path.exists(dest) or \
+                    os.path.getmtime(dest) < os.path.getmtime(source):
                 print 'building documentation file %s' % dest
                 publish_cmdline(writer_name='html',
                                 argv=['--config=%s' % docutils_conf, source,
Copyright (C) 2012-2017 Edgewall Software