Commits

Anonymous committed 93def76

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.
........

Comments (0)

Files changed (6)

doc/_templates/index.html

     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>

sphinx/builder.py

             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 = [],

sphinx/ext/autodoc.py

 
 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,

sphinx/quickstart.py

 
 # 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']
     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.'''
     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'])

sphinx/static/searchtools.js

                     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);

sphinx/templates/layout.html

     {%- 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>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.