summaryrefslogtreecommitdiff
path: root/sphinx/quickstart.py
diff options
context:
space:
mode:
authorgeorg.brandl <devnull@localhost>2008-07-08 18:48:21 +0000
committergeorg.brandl <devnull@localhost>2008-07-08 18:48:21 +0000
commit5ceb259c1a8c2ab4d62705ece8e5c0eca34c625d (patch)
treeabd9b165ba94646468e4f9c9e010476dea9facf8 /sphinx/quickstart.py
parentf5ac3748439475661f00654211bce495e42e10fc (diff)
downloadsphinx-5ceb259c1a8c2ab4d62705ece8e5c0eca34c625d.tar.gz
Merged revisions 64733,64743,64755,64795,64803 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x ........ r64733 | georg.brandl | 2008-07-05 17:04:12 +0200 (Sat, 05 Jul 2008) | 2 lines Ask for common extensions in quickstart. ........ r64743 | georg.brandl | 2008-07-05 18:34:55 +0200 (Sat, 05 Jul 2008) | 2 lines Add a direct link to the examples page. ........ r64755 | georg.brandl | 2008-07-06 07:32:09 +0200 (Sun, 06 Jul 2008) | 2 lines Backport r64750. ........ r64795 | georg.brandl | 2008-07-08 16:48:58 +0200 (Tue, 08 Jul 2008) | 2 lines Use correct filename extension in search. ........ r64803 | georg.brandl | 2008-07-08 20:46:49 +0200 (Tue, 08 Jul 2008) | 2 lines Accept class options for modules too. ........
Diffstat (limited to 'sphinx/quickstart.py')
-rw-r--r--sphinx/quickstart.py11
1 files changed, 10 insertions, 1 deletions
diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py
index 5dfe2018..f452e212 100644
--- a/sphinx/quickstart.py
+++ b/sphinx/quickstart.py
@@ -42,7 +42,7 @@ import sys, os
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-#extensions = []
+extensions = [%(extensions)s]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['%(dot)stemplates']
@@ -397,6 +397,12 @@ document is a custom template, you can also set this to another filename.'''
do_prompt(d, 'master', 'Name of your master document (without suffix)',
'index')
print '''
+Please indicate if you want to use one of the following Sphinx extensions:'''
+ do_prompt(d, 'ext_autodoc', 'autodoc: automatically insert docstrings '
+ 'from modules (y/n)', 'n', boolean)
+ do_prompt(d, 'ext_doctest', 'doctest: automatically test code snippets '
+ 'in doctest blocks (y/n)', 'n', boolean)
+ print '''
If you are under Unix, a Makefile can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.'''
@@ -407,6 +413,9 @@ directly.'''
d['year'] = time.strftime('%Y')
d['now'] = time.asctime()
d['underline'] = len(d['project']) * '='
+ d['extensions'] = ', '.join(
+ repr('sphinx.ext.' + name) for name in ('autodoc', 'doctest')
+ if d['ext_' + name].upper() in ('Y', 'YES'))
if not path.isdir(d['path']):
mkdir_p(d['path'])