diff --git a/CHANGES b/CHANGES index 7f413d04c..9ed1f491f 100644 --- a/CHANGES +++ b/CHANGES @@ -2,6 +2,22 @@ Release 1.2 (in development) ============================ +Release 1.1.1 (Nov 1, 2011) +=========================== + +* #791: Fix QtHelp, DevHelp and HtmlHelp index entry links. + +* #792: Include "sphinx-apidoc" in the source distribution. + +* #797: Don't crash on a misformatted glossary. + +* #801: Make intersphinx work properly without SSL support. + +* #805: Make the ``Sphinx.add_index_to_domain`` method work correctly. + +* #780: Fix Python 2.5 compatibility. + + Release 1.1 (Oct 9, 2011) ========================= @@ -119,13 +135,10 @@ Features added - #714: Added Korean locale. - #766: Added Estonian locale. +* Bugs fixed: -Release 1.0.9 (in development) -============================== - -* #778: Fix "hide search matches" link on pages linked by search. - -* Fix the source positions referenced by the "viewcode" extension. + - #778: Fix "hide search matches" link on pages linked by search. + - Fix the source positions referenced by the "viewcode" extension. Release 1.0.8 (Sep 23, 2011) diff --git a/MANIFEST.in b/MANIFEST.in index cfc44c17e..214b81608 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -11,6 +11,7 @@ include distribute_setup.py include sphinx-autogen.py include sphinx-build.py include sphinx-quickstart.py +include sphinx-apidoc.py recursive-include sphinx/texinputs * recursive-include sphinx/themes * diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index 643de9950..1f5c063c7 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -115,11 +115,8 @@ the following public API: `_ for details. - The directive class normally must inherit from the class - ``docutils.parsers.rst.Directive``. When writing a directive for usage in - a Sphinx extension, you inherit from ``sphinx.util.compat.Directive`` - instead which does the right thing even on docutils 0.4 (which doesn't - support directive classes otherwise). + The directive class must inherit from the class + ``docutils.parsers.rst.Directive``. For example, the (already existing) :rst:dir:`literalinclude` directive would be added like this: diff --git a/doc/intro.rst b/doc/intro.rst index 46e4436bb..5d76dd29c 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -51,7 +51,7 @@ Prerequisites ------------- Sphinx needs at least **Python 2.4** or **Python 3.1** to run, as well as the -docutils_ and Jinja2_ libraries. Sphinx should work with docutils version 0.5 +docutils_ and Jinja2_ libraries. Sphinx should work with docutils version 0.7 or some (not broken) SVN trunk snapshot. If you like to have source code highlighting support, you must also install the Pygments_ library. diff --git a/sphinx/apidoc.py b/sphinx/apidoc.py index 7e7f341fc..16566761b 100644 --- a/sphinx/apidoc.py +++ b/sphinx/apidoc.py @@ -8,7 +8,8 @@ creates a modules index (named modules.). This is derived from the "sphinx-autopackage" script, which is: - Copyright 2008 Société des arts technologiques (SAT), http://www.sat.qc.ca/ + Copyright 2008 Société des arts technologiques (SAT), + http://www.sat.qc.ca/ :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/application.py b/sphinx/application.py index dec9c13c8..bfb39a70f 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -425,11 +425,10 @@ class Sphinx(object): raise ExtensionError('domain %s not yet registered' % domain) self.domains[domain].roles[name] = role - def add_index_to_domain(self, domain, name, localname, shortname, func): + def add_index_to_domain(self, domain, index): if domain not in self.domains: raise ExtensionError('domain %s not yet registered' % domain) - self.domains[domain].indices.append((name, localname, shortname)) - setattr(self.domains[domain], 'get_%s_index' % name, func) + self.domains[domain].indices.append(index) def add_object_type(self, directivename, rolename, indextemplate='', parse_node=None, ref_nodeclass=None, objname='', diff --git a/sphinx/builders/devhelp.py b/sphinx/builders/devhelp.py index a1b419453..62bd22377 100644 --- a/sphinx/builders/devhelp.py +++ b/sphinx/builders/devhelp.py @@ -107,12 +107,12 @@ class DevhelpBuilder(StandaloneHTMLBuilder): pass elif len(refs) == 1: etree.SubElement(functions, 'function', - name=title, link=refs[0]) + name=title, link=refs[0][1]) else: for i, ref in enumerate(refs): etree.SubElement(functions, 'function', name="[%d] %s" % (i, title), - link=ref) + link=ref[1]) if subitems: parent_title = re.sub(r'\s*\(.*\)\s*$', '', title) diff --git a/sphinx/builders/htmlhelp.py b/sphinx/builders/htmlhelp.py index 143f6df9e..f09f42e9a 100644 --- a/sphinx/builders/htmlhelp.py +++ b/sphinx/builders/htmlhelp.py @@ -258,7 +258,8 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder): f.write('