[Python-checkins] r64804 - in doctools/trunk: doc/_templates/index.html sphinx/builder.py sphinx/ext/autodoc.py sphinx/quickstart.py sphinx/static/searchtools.js sphinx/templates/layout.html

Tue Jul 8 20:48:30 CEST 2008

Author: georg.brandl
Date: Tue Jul 8 20:48:21 2008
New Revision: 64804
Log:
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 (2008年7月05日) | 2 lines
 
 Ask for common extensions in quickstart.
........
 r64743 | georg.brandl | 2008年07月05日 18:34:55 +0200 (2008年7月05日) | 2 lines
 
 Add a direct link to the examples page.
........
 r64755 | georg.brandl | 2008年07月06日 07:32:09 +0200 (2008年7月06日) | 2 lines
 
 Backport r64750.
........
 r64795 | georg.brandl | 2008年07月08日 16:48:58 +0200 (2008年7月08日) | 2 lines
 
 Use correct filename extension in search.
........
 r64803 | georg.brandl | 2008年07月08日 20:46:49 +0200 (2008年7月08日) | 2 lines
 
 Accept class options for modules too.
........
Modified:
 doctools/trunk/ (props changed)
 doctools/trunk/doc/_templates/index.html
 doctools/trunk/sphinx/builder.py
 doctools/trunk/sphinx/ext/autodoc.py
 doctools/trunk/sphinx/quickstart.py
 doctools/trunk/sphinx/static/searchtools.js
 doctools/trunk/sphinx/templates/layout.html
Modified: doctools/trunk/doc/_templates/index.html
==============================================================================

--- doctools/trunk/doc/_templates/index.html	(original)
+++ doctools/trunk/doc/_templates/index.html	Tue Jul 8 20:48:21 2008
@@ -44,6 +44,9 @@
 You can also download a <a href="http://sphinx.pocoo.org/sphinx.pdf">PDF version</a>
 of the Sphinx documentation, generated from the LaTeX Sphinx produces.
 </p>
+ <p>Links to more documentation generated with Sphinx can be found on the
+ <a href="{{ pathto("examples") }}">Projects using Sphinx</a> page.
+ </p>
 
 <h2>Documentation</h2>
 <table class="contentstable" align="center" style="margin-left: 30px"><tr>
Modified: doctools/trunk/sphinx/builder.py
==============================================================================
--- doctools/trunk/sphinx/builder.py	(original)
+++ doctools/trunk/sphinx/builder.py	Tue Jul 8 20:48:21 2008
@@ -378,6 +378,7 @@
 docstitle = self.config.html_title,
 shorttitle = self.config.html_short_title,
 show_sphinx = self.config.html_show_sphinx,
+ file_suffix = self.config.html_file_suffix,
 rellinks = rellinks,
 builder = self.name,
 parents = [],
Modified: doctools/trunk/sphinx/ext/autodoc.py
==============================================================================
--- doctools/trunk/sphinx/ext/autodoc.py	(original)
+++ doctools/trunk/sphinx/ext/autodoc.py	Tue Jul 8 20:48:21 2008
@@ -560,7 +560,8 @@
 
 def setup(app):
 mod_options = {'members': members_option, 'undoc-members': directives.flag,
- 'noindex': directives.flag, 'synopsis': lambda x: x,
+ 'noindex': directives.flag, 'inherited-members': directives.flag,
+ 'show-inheritance': directives.flag, 'synopsis': lambda x: x,
 'platform': lambda x: x, 'deprecated': directives.flag}
 cls_options = {'members': members_option, 'undoc-members': directives.flag,
 'noindex': directives.flag, 'inherited-members': directives.flag,
Modified: doctools/trunk/sphinx/quickstart.py
==============================================================================
--- doctools/trunk/sphinx/quickstart.py	(original)
+++ doctools/trunk/sphinx/quickstart.py	Tue Jul 8 20:48:21 2008
@@ -42,7 +42,7 @@
 
 # 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 @@
 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 @@
 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'])
Modified: doctools/trunk/sphinx/static/searchtools.js
==============================================================================
--- doctools/trunk/sphinx/static/searchtools.js	(original)
+++ doctools/trunk/sphinx/static/searchtools.js	Tue Jul 8 20:48:21 2008
@@ -363,8 +363,10 @@
 if (results.length) {
 var item = results.pop();
 var listItem = $('<li style="display:none"></li>');
- listItem.append($('<a/>').attr('href', item[0] + '.html' +
- highlightstring).html(item[1]));
+ listItem.append($('<a/>').attr(
+ 'href',
+ item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
+ highlightstring).html(item[1]));
 $.get('_sources/' + item[0] + '.txt', function(data) {
 listItem.append($.makeSearchSummary(data, searchwords, hlwords));
 output.append(listItem);
Modified: doctools/trunk/sphinx/templates/layout.html
==============================================================================
--- doctools/trunk/sphinx/templates/layout.html	(original)
+++ doctools/trunk/sphinx/templates/layout.html	Tue Jul 8 20:48:21 2008
@@ -102,9 +102,10 @@
 {%- if builder != 'htmlhelp' %}
 <script type="text/javascript">
 var DOCUMENTATION_OPTIONS = {
- URL_ROOT: '{{ pathto("", 1) }}',
- VERSION: '{{ release }}',
- COLLAPSE_MODINDEX: false
+ URL_ROOT: '{{ pathto("", 1) }}',
+ VERSION: '{{ release }}',
+ COLLAPSE_MODINDEX: false,
+ FILE_SUFFIX: '{{ file_suffix }}'
 };
 </script>
 <script type="text/javascript" src="{{ pathto('_static/jquery.js', 1) }}"></script>
