From: Christopher Lenz <cmlenz@gmail.com>
Date: Wed, 13 Jun 2007 07:48:06 +0000 (+0000)
Subject: Add `--without-apidocs` switch to `build_doc` command for quicker doc-edit/review... 
X-Git-Tag: 1.0~531
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f9745c54585dc345b71adc7e0fa4980500ac7d26;p=thirdparty%2Fbabel.git

Add `--without-apidocs` switch to `build_doc` command for quicker doc-edit/review cycles.
---

diff --git a/doc/formatting.txt b/doc/formatting.txt
index 5b2dba45..44787aa2 100644
--- a/doc/formatting.txt
+++ b/doc/formatting.txt
@@ -14,10 +14,12 @@ Date Formatting
 ===============
 
 When working with date and time information in Python, you commonly use the
-classes ``date``, ``datetime`` and/or ``time`` from the `datetime package`_.
+classes ``date``, ``datetime`` and/or ``time`` from the `datetime`_ package.
 Babel provides functions for locale-specific formatting of those objects in its
 ``dates`` module:
 
+.. _`datetime`: http://docs.python.org/lib/module-datetime.html
+
 .. code-block:: pycon
 
     >>> from datetime import date, datetime, time
@@ -51,8 +53,6 @@ For example:
     >>> format_date(d, format='full', locale='en')
     u'Sunday, April 1, 2007'
 
-.. _`datetime package`: http://docs.python.org/lib/module-datetime.html
-
 
 Pattern Syntax
 --------------
diff --git a/setup.py b/setup.py
index a6e1fccf..b27adc9f 100755
--- a/setup.py
+++ b/setup.py
@@ -25,10 +25,14 @@ import sys
 
 class build_doc(Command):
     description = 'Builds the documentation'
-    user_options = []
+    user_options = [
+        ('without-apidocs', None,
+         "whether to skip the generation of API documentaton"),
+    ]
+    boolean_options = ['without-apidocs']
 
     def initialize_options(self):
-        pass
+        self.without_apidocs = False
 
     def finalize_options(self):
         pass
@@ -67,20 +71,21 @@ class build_doc(Command):
                                 argv=['--config=%s' % docutils_conf, source,
                                       dest])
 
-        try:
-            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.'
+        if not self.without_apidocs:
+            try:
+                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.'
 
 
 class test_doc(Command):