Date: Sun, 17 Mar 2013 10:55:50 +0900
Subject: [PATCH 17/76] update CHANGES
---
CHANGES | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/CHANGES b/CHANGES
index effaa10a4..8555abb8c 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,6 +1,10 @@
Release 1.2 (in development)
============================
+* PR#124: Fix paragraphs in versionmodified are ignored when it has no
+ dangling paragraphs. Fix wrong html output (nested tag). Fix
+ versionmodified is not translatable. Thanks to Nozomu Kaneko.
+
* PR#123, #1106: Add epub_use_index configuration value.
If provided, it will be used instead of html_use_index for epub builder.
From 87391201b72f5260325bfe925787561e0cebc5ea Mon Sep 17 00:00:00 2001
From: Takayuki Shimizukawa
Date: Fri, 29 Mar 2013 09:35:47 +0900
Subject: [PATCH 18/76] add 'Adobe Enterprise Toolkit' link for EXAMPLE
---
EXAMPLES | 1 +
1 file changed, 1 insertion(+)
diff --git a/EXAMPLES b/EXAMPLES
index 77d1f3a1d..45f5d0dee 100644
--- a/EXAMPLES
+++ b/EXAMPLES
@@ -140,6 +140,7 @@ Documentation using another builtin theme
Documentation using a custom theme/integrated in a site
-------------------------------------------------------
+* Adobe Enterprise Toolkit: http://www.adobe.com/devnet-docs/acrobatetk/
* Blender: http://www.blender.org/documentation/250PythonDoc/
* Blinker: http://discorporate.us/projects/Blinker/docs/
* Classy: http://classy.pocoo.org/
From 4659e4054e4e254fdd2239069db2a5bdb2a6c793 Mon Sep 17 00:00:00 2001
From: Takayuki Shimizukawa
Date: Fri, 29 Mar 2013 09:39:44 +0900
Subject: [PATCH 19/76] using proper page title for Adobe's EXAMPLE link
---
EXAMPLES | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/EXAMPLES b/EXAMPLES
index 45f5d0dee..eb270d93e 100644
--- a/EXAMPLES
+++ b/EXAMPLES
@@ -140,12 +140,12 @@ Documentation using another builtin theme
Documentation using a custom theme/integrated in a site
-------------------------------------------------------
-* Adobe Enterprise Toolkit: http://www.adobe.com/devnet-docs/acrobatetk/
* Blender: http://www.blender.org/documentation/250PythonDoc/
* Blinker: http://discorporate.us/projects/Blinker/docs/
* Classy: http://classy.pocoo.org/
* DEAP: http://deap.gel.ulaval.ca/doc/0.8/index.html
* Django: http://docs.djangoproject.com/
+* Enterprise Toolkit for Acrobat products: http://www.adobe.com/devnet-docs/acrobatetk/
* e-cidadania: http://e-cidadania.readthedocs.org/en/latest/
* Flask: http://flask.pocoo.org/docs/
* Flask-OpenID: http://packages.python.org/Flask-OpenID/
From c4a999f682bcf686a59ebfe9e165fbcab9ab8f70 Mon Sep 17 00:00:00 2001
From: Takayuki Shimizukawa
Date: Fri, 29 Mar 2013 10:45:24 +0900
Subject: [PATCH 20/76] add missing `mathjax_path` default value in document.
---
doc/ext/math.rst | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/doc/ext/math.rst b/doc/ext/math.rst
index 91376d15d..85e67b5b4 100644
--- a/doc/ext/math.rst
+++ b/doc/ext/math.rst
@@ -195,8 +195,10 @@ Sphinx.
The path to the JavaScript file to include in the HTML files in order to load
MathJax.
- The default is the ``http://`` URL that loads the JS files from the `MathJax
- CDN `_. If you want MathJax to
+ The default is the
+ ``http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML``
+ URL that loads the JS files from the `MathJax CDN
+ `_. If you want MathJax to
be available offline, you have to donwload it and set this value to a
different path.
From e30b1325ef0d82c769a91411bd3831cf96093de9 Mon Sep 17 00:00:00 2001
From: Takayuki Shimizukawa
Date: Fri, 29 Mar 2013 10:52:52 +0900
Subject: [PATCH 21/76] Because it was thought MaxJax CDN URL has not been
written intentionally, I undo the changes. See also #683. Backed out
changeset 2f9a30b7d005.
---
doc/ext/math.rst | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/doc/ext/math.rst b/doc/ext/math.rst
index 85e67b5b4..91376d15d 100644
--- a/doc/ext/math.rst
+++ b/doc/ext/math.rst
@@ -195,10 +195,8 @@ Sphinx.
The path to the JavaScript file to include in the HTML files in order to load
MathJax.
- The default is the
- ``http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML``
- URL that loads the JS files from the `MathJax CDN
- `_. If you want MathJax to
+ The default is the ``http://`` URL that loads the JS files from the `MathJax
+ CDN `_. If you want MathJax to
be available offline, you have to donwload it and set this value to a
different path.
From 663599abe9b1026123ddf5e4acf898b2d7a2001a Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 11:17:04 +0100
Subject: [PATCH 22/76] quickstart: simplify the check for the "sphinx-build"
command in the Makefile
The previous check called the "sphinx-build" executable on every invocation
of the Makefile, which takes a nontrivial time to import all required modules.
Calling "which" is much faster.
---
sphinx/quickstart.py | 21 ++++++++-------------
1 file changed, 8 insertions(+), 13 deletions(-)
diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py
index bfc6d723b..d9c5c2112 100644
--- a/sphinx/quickstart.py
+++ b/sphinx/quickstart.py
@@ -389,19 +389,14 @@ SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = %(rbuilddir)s
-ifeq ($(shell $(SPHINXBUILD) 2> /dev/null; echo $$?), 127)
-define MSG
-
-
-The 'sphinx-build' command was not found. Make sure you have Sphinx
-installed, then set the SPHINXBUILD environment variable to point
-to the full path of the 'sphinx-build' executable. Alternatively you
-may add the Sphinx directory to PATH.
-
-If you don't have Sphinx installed, grab it from
-http://sphinx-doc.org/
-endef
-$(error $(MSG))
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error \
+The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx \
+installed, then set the SPHINXBUILD environment variable to point \
+to the full path of the '$(SPHINXBUILD)' executable. Alternatively you \
+can add the directory with the executable to your PATH. \
+If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
From 519be8ed6ea9febdc37562fd4cbf6e3b5d1e71e6 Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 11:17:34 +0100
Subject: [PATCH 23/76] html builder: rename get_object_hash to get_stable hash
Also amend the docstring so that it is easier to understand the need for the function.
---
sphinx/builders/html.py | 20 ++++++++------------
1 file changed, 8 insertions(+), 12 deletions(-)
diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py
index 198824ee2..3142fd964 100644
--- a/sphinx/builders/html.py
+++ b/sphinx/builders/html.py
@@ -53,20 +53,16 @@ INVENTORY_FILENAME = 'objects.inv'
LAST_BUILD_FILENAME = 'last_build'
-def get_object_hash(obj):
+def get_stable_hash(obj):
"""
- In python3.3, unicode(dict_instance) retun another string per process.
- get_object_hash(dict_instance) return same hash for same dict_instance.
+ Return a stable hash for a Python data structure. We can't just use
+ the md5 of str(obj) since for example dictionary items are enumerated
+ in unpredictable order due to hash randomization in newer Pythons.
"""
if isinstance(obj, dict):
- return get_object_hash(list(obj.items()))
-
+ return get_stable_hash(list(obj.items()))
elif isinstance(obj, (list, tuple)):
- obj = sorted(get_object_hash(o) for o in obj)
-
- else: # int or other objects
- pass
-
+ obj = sorted(get_stable_hash(o) for o in obj)
return md5(unicode(obj).encode('utf8')).hexdigest()
@@ -173,8 +169,8 @@ class StandaloneHTMLBuilder(Builder):
cfgdict = dict((name, self.config[name])
for (name, desc) in self.config.values.iteritems()
if desc[1] == 'html')
- self.config_hash = get_object_hash(cfgdict)
- self.tags_hash = get_object_hash(sorted(self.tags))
+ self.config_hash = get_stable_hash(cfgdict)
+ self.tags_hash = get_stable_hash(sorted(self.tags))
old_config_hash = old_tags_hash = ''
try:
fp = open(path.join(self.outdir, '.buildinfo'))
From d492aad352489842fce11d4154a882a6360b3d21 Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 11:45:07 +0100
Subject: [PATCH 24/76] docs: proofread installation document
---
doc/install.rst | 156 ++++++++++++++++++++++--------------------------
1 file changed, 70 insertions(+), 86 deletions(-)
diff --git a/doc/install.rst b/doc/install.rst
index d4457899e..b1e0e5b61 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -1,11 +1,12 @@
:orphan:
Installing Sphinx
-==================
+=================
-Sphinx is written by Python, you need to install Python and Sphinx.
+Since Sphinx is written in the Python language, you need to install Python
+(the required version is at least 2.5) and Sphinx.
-Sphinx package is available as a package on the `Python Package Index
+Sphinx packages are available on the `Python Package Index
`_.
You can also download a snapshot from the Mercurial development repository:
@@ -14,7 +15,7 @@ You can also download a snapshot from the Mercurial development repository:
file or
* as a `.zip `_ file
-There is introductions for each environments:
+There are introductions for several environments:
.. contents::
:depth: 1
@@ -22,145 +23,128 @@ There is introductions for each environments:
:backlinks: none
-Install by your own
---------------------
-
-If you use system installed Python or build your own Python, you can
-use that python to install Sphinx. The actual command list is same as
-these install.
-
-* `Install easy_install command`_
-* `Install Sphinx`_
-
-
Debian/Ubuntu: Install Sphinx using packaging system
------------------------------------------------------
+----------------------------------------------------
You may install using this command if you use Debian/Ubuntu.
.. code-block:: bash
- $ aptitude install python-sphinx
+ $ apt-get install python-sphinx
+
+
+Other Linux distributions
+-------------------------
+
+Most Linux distributions have Sphinx in their package repositories. Usually the
+package is called "python-sphinx", "python-Sphinx" or "sphinx". Be aware that
+there are two other packages with "sphinx" in their name: a speech recognition
+toolkit (CMU Sphinx) and a full-text search database (Sphinx search).
Mac OS X: Install Sphinx using MacPorts
-----------------------------------------
+---------------------------------------
-If you use Mac OS X `MacPorts `_ , use this
-command to install all software.
+If you use Mac OS X `MacPorts `_, use this command to
+install all necessary software.
.. code-block:: bash
$ sudo port install py27-sphinx
-However, the execution path is not added, use select command to use
-Python2.7 as default.
+To set up the executable paths, use the ``port select`` command:
.. code-block:: bash
$ sudo port select --set python python27
$ sudo port select --set sphinx py27-sphinx
-Type :command:`which sphinx-quickstart` to check the installation.
+Type :command:`which sphinx-quickstart` to check if the installation was
+successful.
Windows: Install Python and Sphinx
------------------------------------
+----------------------------------
-Intall Python
+Install Python
^^^^^^^^^^^^^^
-Almost every Windows user do not have Python, we begin Python
-installation. If you already install python, please skip this section.
+Most Windows users do not have Python, so we begin with the installation of
+Python itself. If you have already installed Python, please skip this section.
-Go to http://python.org . This site is a headquarter of the
-Python. Look at Left sidebar and "Quick Links", Click "Windows
-Installer" to download.
+Go to http://python.org, the main download site for Python. Look at the left
+sidebar and under "Quick Links", click "Windows Installer" to download.
.. image:: pythonorg.png
.. note::
- Currently, Python has two version, 2.X and 3.X. Sphinx-1.2 can
- run under Python-2.5, 2.6, 2.7, 3.1, 3.2, 3.3.
- You may get some advice from ML or other places.
+ Currently, Python offers two major versions, 2.x and 3.x. Sphinx 1.2 can run
+ under Python 2.5 to 2.7 and 3.1 to 3.3, with the recommended version being
+ 2.7. This chapter assumes you have installed Python 2.7.
- This chapter assumes Python-2.7.
-
-
-Follow the normal Windows installer, the Python install will be completed.
+Follow the Windows installer for Python.
.. image:: installpython.jpg
-After installation, you have better to add PATH to the Environment
-Variable in order to run Python from Command Prompt.
+After installation, you better add the Python executable directories to the
+environment variable ``PATH`` in order to run Python and package commands such
+as ``sphinx-build`` easily from the Command Prompt.
-* Right-Click the My Computer Icon and open Property Dialog
-* Click Environment Variable button under detail tab
-* Edit and add the path to the system variables PATH
+* Right-click the "My Computer" icon and choose "Properties"
+* Click the "Environment Variables" button under the "Advanced" tab
-Add these variables. This is for Python-2.7. If you use another version
-of Python, change the "27" number. Add these pathes separeted by ";".
+* If "Path" (or "PATH") is already an entry in the "System variables" list, edit
+ it. If it is not present, add a new variable called "PATH".
-.. list-table:: Adding PATH
- :widths: 10 40
- :header-rows: 1
+* Add these paths, separating entries by ";":
- * - PATH
- - description
- * - C:\\Python27
- - Folder which includes Python Command
- * - C:\\Python27\\Scripts
- - Folder which includes easy_install (described later) or sphinx commands
+ - ``C:\Python27`` -- this folder contains the main Python executable
+ - ``C:\Python27\Scripts`` -- this folder will contain executables added by
+ Python packages installed with easy_install (see below)
-Run **Command Prompt** or enter ``cmd`` to the "search program and
-files" text box. After command prompt window appear, type
-``python[Enter]``. If you can get installed python version and prompt
-about ``>>>``, the Python installation is succeeded. Enter ``Ctrl+Z``
-key to quit.
+ This is for Python 2.7. If you use another version of
+ Python or installed to a non-default location, change the digits "27"
+ accordingly.
+
+* Now run the **Command Prompt**. After command prompt window appear, type
+ ``python`` and Enter. If the Python installation was successful, the
+ installed Python version is printed, and you are greeted by the prompt
+ ``>>>``. Type ``Ctrl+Z`` and Enter to quit.
-Install easy_install command
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Install the easy_install command
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Python has very useful :command:`easy_install` command which install 3rd
-party library.
+Python has a very useful :command:`easy_install` command which can download and
+install 3rd-party libraries with a single command. This is provided by the
+"distribute" project: http://pypi.python.org/pypi/distribute.
-* http://pypi.python.org/pypi/distribute
-
-easy_install downloads and install software which you want to need by only
-one command.
-
-
-Save http://distribute.org/distribute_setup.py link by Right-click.
-Some browsers can download just open the URL.
-If you can read the file iteslf, calm down, Right-click and choose "Save".
-
-After download, invoke command prompt, go to the distribute_setup.py saved
-directory and run this command:
+To install distribute, download http://distribute.org/distribute_setup.py and
+save it somewhere. After download, invoke the command prompt, go to the
+directory with distribute_setup.py and run this command:
.. code-block:: bat
C:\> python distribute_setup.py
-Now :command:`easy_insall` command is installed. OK, Let's go to the Sphinx
-install!
+Now distribute and its :command:`easy_install` command is installed. From there
+we can go to the Sphinx install.
-Install Sphinx
-^^^^^^^^^^^^^^^
+Installing Sphinx with easy_install
+-----------------------------------
-If you finshed easy_install install, for the rest is just a moment.
-Type this line.
+If you finished the installation of distribute, type this line in the command
+prompt:
.. code-block:: bat
C:\> easy_install sphinx
-After installation, type :command:`sphinx-quickstart` on the command
-prompt. If you get interactive messages which starts with
-``Welcome to the Sphinx quickstart utility.``,
-installation is succeeded. Quit by hitting ``Ctrl+C``.
-
-That it. Install is over. Let's go to :doc:`tutorial` to make Sphinx project.
+After installation, type :command:`sphinx-build` on the command prompt. If
+everything worked fine, you will get a Sphinx version number and a list of
+options for this command.
+That it. Installation is over. Head to :doc:`tutorial` to make a Sphinx
+project.
From 20da688d51870cf668e7cc9e80e0a059b1ff09f5 Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 11:49:06 +0100
Subject: [PATCH 25/76] nodes util: update docutils tracker link
---
sphinx/util/nodes.py | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py
index 5a7749bef..640ef4955 100644
--- a/sphinx/util/nodes.py
+++ b/sphinx/util/nodes.py
@@ -10,6 +10,7 @@
"""
import re
+import sys
from docutils import nodes
@@ -234,16 +235,16 @@ def _new_copy(self):
nodes.Element.copy = _new_copy
-# monkey-patch Element.__repr__ to return str if include unicode.
-# sf.net/tracker/?func=detail&aid=3601607&group_id=38414&atid=422030
-import sys
+# monkey-patch Element.__repr__ to return str if it returns unicode.
+# Was fixed in docutils since 0.10. See sf.net/p/docutils/bugs/218/.
+
if sys.version_info < (3,):
_element_repr_orig = nodes.Element.__repr__
-
- def _repr(self):
+
+ def _new_repr(self):
s = _element_repr_orig(self)
if isinstance(s, unicode):
return s.encode('utf-8')
return s
-
- nodes.Element.__repr__ = _repr
+
+ nodes.Element.__repr__ = _new_repr
From 3bf631527cb8e084ea117abb3625cd7b449ace5a Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:09:20 +0100
Subject: [PATCH 26/76] changelog: categorize 1.2 entries in features by
component and bugfixes
---
CHANGES | 305 +++++++++++++++++++++++++++-----------------------------
1 file changed, 145 insertions(+), 160 deletions(-)
diff --git a/CHANGES b/CHANGES
index 208b841d5..aa5e5ef39 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,171 +1,30 @@
Release 1.2 (in development)
============================
-* Add i18n capabilities for custom templates.
- For example: The Sphinx reference documentation in doc directory provides
- sphinx.pot file from ``doc/_templates/*.html`` by ``make gettext``.
+There should be no backwards-incompatible changes in this version.
-* PR#124: Fix paragraphs in versionmodified are ignored when it has no
- dangling paragraphs. Fix wrong html output (nested tag). Fix
- versionmodified is not translatable. Thanks to Nozomu Kaneko.
+Features added
+--------------
-* PR#123, #1106: Add epub_use_index configuration value.
- If provided, it will be used instead of html_use_index for epub builder.
+* Markup
-* #1111: Fix uppercase word is not found in search when
- html_search_language='ja'. Thanks to tomo saito.
+ - The :rst:dir:`toctree` directive and the ``toctree()`` template function now
+ have an ``includehidden`` option that includes hidden toctree entries (bugs
+ #790 and #1047). A bug in the ``maxdepth`` option for the ``toctree()``
+ template function has been fixed (bug #1046).
+ - PR#99: Strip down seealso directives to normal admonitions. This removes
+ their unusual CSS classes (admonition-see-also), inconsistent LaTeX
+ admonition title ("See Also" instead of "See also"), and spurious indentation
+ in the text builder.
-* The ``'fontpkg'`` item in :confval:`latex_elements` now defaults to ``''``
- when the :confval:`language` uses the Cyrillic script.
- Suggested by Dmitry Shachnev.
+* HTML builder
-* PR#114: The LaTeX writer now includes the "cmap" package by default. The
- ``'cmappkg'`` item in :confval:`latex_elements` can be used to control this.
- Thanks to Dmitry Shachnev.
-
-* New locales: #1113: Added Hebrew locale.
-
-* PR#115: Add ``'transition'`` item in :confval:`latex_elements` for
- customizing how transitions are displayed. Thanks to Jeff Klukas.
-
-* #1108: The text writer now correctly numbers enumerated lists with
- non-default start values (based on patch by Ewan Edwards).
-
-* #1074: Add environment version info to the generated search index to avoid
- compatibility issues with old builds.
-
-* New locales: #1097: Added Basque locale.
-
-* Fix text builder did not respect wide/fullwidth characters:
- title underline width, table layout width and text wrap width.
-
-* Add stub for the :confval:`keep_warnings` configuration value in the
- ``conf.py`` generated by sphinx-quickstart.
-
-* Speed up building the search index by caching the results of the word
- stemming routines. Saves about 20 seconds when building the Python
- documentation.
-
-* #1062: sphinx.ext.autodoc use __init__ method signature for class signature.
-
-* PR#111: Respect add_autodoc_attrgetter() even when inherited-members is set.
- Thanks to A. Jesse Jiryu Davis.
-
-* #1090: Fix gettext does not extract glossary terms.
-
-* #1070: Avoid un-pickling issues when running Python 3 and the saved
- environment was created under Python 2.
-
-* #1069: Fixed error caused when autodoc would try to format signatures of
- "partial" functions without keyword arguments (patch by Artur Gaspar).
-
-* The :confval:`latex_documents`, :confval:`texinfo_documents`, and
- :confval:`man_pages` configuration values will be set to default values based
- on the :confval:`master_doc` if not explicitly set in :file:`conf.py`.
- Previously, if these values were not set, no output would be genereted by
- their respective builders.
-
-* The :rst:dir:`toctree` directive and the ``toctree()`` template function now
- have an ``includehidden`` option that includes hidden toctree entries (bugs
- #790 and #1047). A bug in the ``maxdepth`` option for the ``toctree()``
- template function has been fixed (bug #1046).
-
-* PR#99: Strip down seealso directives to normal admonitions. This removes
- their unusual CSS classes (admonition-see-also), inconsistent LaTeX
- admonition title ("See Also" instead of "See also"), and spurious indentation
- in the text builder.
-
-* sphinx-build now has a verbose option :option:`-v` which can be
- repeated for greater effect. A single occurrance provides a
- slightly more verbose output than normal. Two or more occurrences
- of this option provides more detailed output which may be useful for
- debugging.
-
-* sphinx-build now provides more specific error messages when called with
- invalid options or arguments.
-
-* sphinx-build now supports the standard :option:`--help` and
- :option:`--version` options.
-
-* #869: sphinx-build now has the option :option:`-T` for printing the full
- traceback after an unhandled exception.
-
-* #976: Fix gettext does not extract index entries.
-
-* #940: Fix gettext does not extract figure caption.
-
-* #1067: Improve the ordering of the JavaScript search results: matches in titles
- come before matches in full text, and object results are better categorized.
- Also implement a pluggable search scorer.
-
-* Fix text writer can not handle visit_legend for figure directive contents.
-
-* PR#72: #975: Fix gettext does not extract definition terms before docutils 0.10.0
-
-* PR#25: In inheritance diagrams, the first line of the class docstring
- is now the tooltip for the class.
-
-* PR#47: Added :mod:`sphinx.ext.linkcode` extension.
-
-* PR#75: Added ``--follow-links`` option to sphinx-apidoc.
-
-* PR#45: The linkcheck builder now checks ``#anchor``\ s for existence.
-
-* PR#28: Added Hungarian translation.
-
-* PR#35: Added Slovak translation.
-
-* PR#54: Added Norwegian bokmaal translation.
-
-* PR#52: ``special_members`` flag to autodoc now behaves like ``members``.
-
-* #955: Fix i18n transformation.
-
-* PR#74: Fix some Russian translation.
-
-* PR#97: Fix footnote handling in translated documents.
-
-* Update to jQuery 1.7.1 and Underscore.js 1.3.1.
-
-* #1055: Fix web support with relative path to source directory.
-
-* #1053: The "rightsidebar" and "collapsiblesidebar" HTML theme options now work together.
-
-* #1015: Stop overriding jQuery contains() in the JavaScript.
-
-* #1028: Fix line block output in the text builder.
-
-* #1018: Fix "container" directive handling in the text builder.
-
-* #1012: Update Estonian translation.
-
-* #1010: Make pngmath images transparent by default; IE7+ should handle it.
-
-* #440: Fix coarse timestamp resolution in some filesystem generate wrong outdated file-list.
-
-* #1008: Fix test failures with Python 3.3.
-
-* #1029: Fix intersphinx_mapping values are not stable if mapping have plural key/value set with Python 3.3.
-
-* #920: Rescue PIL packaging issue that allow import Image without PIL namespace. Thanks to Marc Schlaich.
-
-* #1024: Improve Makefile/make.bat error message if Sphinx is not found. Thanks to anatoly techtonik.
-
-* #1037: Fix typos in Polish translation. Thanks to Jakub Wilk.
-
-* #1038: Fix cpp domain parser fails to parse C+11 "static constexpr" declarations. Thanks to Jakub Wilk.
-
-* #1043: Fix sphinx-quickstart asks again and again Y|N because input() return value with extra '\r' on Python-3.2.0 + Windows. Thanks to Régis Décamps.
-
-* #1041: Fix cpp domain parser fails to parse a const type with a modifier.
-
-* #958: Do not preserve ``environment.pickle`` after a failed build.
-
-* PR#88: Added the "Sphinx Developer's Guide" (:file:`doc/devguide.rst`)
- which outlines the basic development process of the Sphinx project.
-
-* Added the Docutils-native XML and pseudo-XML builders. See
- :class:`XMLBuilder` and :class:`PseudoXMLBuilder`.
+ - #1067: Improve the ordering of the JavaScript search results: matches in titles
+ come before matches in full text, and object results are better categorized.
+ Also implement a pluggable search scorer.
+ - #1053: The "rightsidebar" and "collapsiblesidebar" HTML theme options now work
+ together.
+ - Update to jQuery 1.7.1 and Underscore.js 1.3.1.
* Texinfo builder
@@ -198,6 +57,132 @@ Release 1.2 (in development)
- Fixed an issue where duplicate domain indices would result in invalid
output.
+* LaTeX builder:
+
+ - PR#115: Add ``'transition'`` item in :confval:`latex_elements` for
+ customizing how transitions are displayed. Thanks to Jeff Klukas.
+ - PR#114: The LaTeX writer now includes the "cmap" package by default. The
+ ``'cmappkg'`` item in :confval:`latex_elements` can be used to control this.
+ Thanks to Dmitry Shachnev.
+ - The ``'fontpkg'`` item in :confval:`latex_elements` now defaults to ``''``
+ when the :confval:`language` uses the Cyrillic script. Suggested by Dmitry
+ Shachnev.
+ - The :confval:`latex_documents`, :confval:`texinfo_documents`, and
+ :confval:`man_pages` configuration values will be set to default values based
+ on the :confval:`master_doc` if not explicitly set in :file:`conf.py`.
+ Previously, if these values were not set, no output would be genereted by
+ their respective builders.
+
+* Internationalization:
+
+ - Add i18n capabilities for custom templates. For example: The Sphinx
+ reference documentation in doc directory provides a ``sphinx.pot`` file with
+ message strings from ``doc/_templates/*.html`` when using ``make gettext``.
+
+* Other builders:
+
+ - Added the Docutils-native XML and pseudo-XML builders. See
+ :class:`XMLBuilder` and :class:`PseudoXMLBuilder`.
+ - PR#45: The linkcheck builder now checks ``#anchor``\ s for existence.
+ - PR#123, #1106: Add epub_use_index configuration value. If provided, it will
+ be used instead of html_use_index for epub builder.
+
+* Extensions:
+
+ - PR#52: ``special_members`` flag to autodoc now behaves like ``members``.
+ - PR#47: Added :mod:`sphinx.ext.linkcode` extension.
+ - PR#25: In inheritance diagrams, the first line of the class docstring
+ is now the tooltip for the class.
+
+* Command-line interfaces:
+
+ - PR#75: Added ``--follow-links`` option to sphinx-apidoc.
+ - #869: sphinx-build now has the option :option:`-T` for printing the full
+ traceback after an unhandled exception.
+ - sphinx-build now supports the standard :option:`--help` and
+ :option:`--version` options.
+ - sphinx-build now provides more specific error messages when called with
+ invalid options or arguments.
+ - sphinx-build now has a verbose option :option:`-v` which can be repeated for
+ greater effect. A single occurrance provides a slightly more verbose output
+ than normal. Two or more occurrences of this option provides more detailed
+ output which may be useful for debugging.
+
+* Locales:
+
+ - PR#74: Fix some Russian translation.
+ - PR#54: Added Norwegian bokmaal translation.
+ - PR#35: Added Slovak translation.
+ - PR#28: Added Hungarian translation.
+ - #1113: Add Hebrew locale.
+ - #1097: Add Basque locale.
+ - #1037: Fix typos in Polish translation. Thanks to Jakub Wilk.
+ - #1012: Update Estonian translation.
+
+* Optimizations:
+
+ - Speed up building the search index by caching the results of the word
+ stemming routines. Saves about 20 seconds when building the Python
+ documentation.
+
+Documentation
+-------------
+
+* PR#88: Added the "Sphinx Developer's Guide" (:file:`doc/devguide.rst`)
+ which outlines the basic development process of the Sphinx project.
+* Added a detailed "Installing Sphinx" document (:file:`doc/install.rst`).
+
+Bugs fixed
+----------
+
+* PR#124: Fix paragraphs in versionmodified are ignored when it has no
+ dangling paragraphs. Fix wrong html output (nested ``
`` tag). Fix
+ versionmodified is not translatable. Thanks to Nozomu Kaneko.
+* PR#111: Respect add_autodoc_attrgetter() even when inherited-members is set.
+ Thanks to A. Jesse Jiryu Davis.
+* PR#97: Fix footnote handling in translated documents.
+* Fix text writer not handling visit_legend for figure directive contents.
+* Fix text builder not respecting wide/fullwidth characters: title underline
+ width, table layout width and text wrap width.
+* #1111: Fix failure to find uppercase words in search when
+ :confval:`html_search_language` is 'ja'. Thanks to Tomo Saito.
+* #1108: The text writer now correctly numbers enumerated lists with
+ non-default start values (based on patch by Ewan Edwards).
+* #1090: Fix gettext not extracting glossary terms.
+* #1074: Add environment version info to the generated search index to avoid
+ compatibility issues with old builds.
+* #1070: Avoid un-pickling issues when running Python 3 and the saved
+ environment was created under Python 2.
+* #1069: Fixed error caused when autodoc would try to format signatures of
+ "partial" functions without keyword arguments (patch by Artur Gaspar).
+* #1062: sphinx.ext.autodoc use __init__ method signature for class signature.
+* #1055: Fix web support with relative path to source directory.
+* #1043: Fix sphinx-quickstart asking again for yes/no questions because
+ ``input()`` returns values with an extra '\r' on Python 3.2.0 +
+ Windows. Thanks to Régis Décamps.
+* #1041: Fix failure of the cpp domain parser to parse a const type with a
+ modifier.
+* #1038: Fix failure of the cpp domain parser to parse C+11 "static constexpr"
+ declarations. Thanks to Jakub Wilk.
+* #1029: Fix intersphinx_mapping values not being stable if the mapping has
+ plural key/value set with Python 3.3.
+* #1028: Fix line block output in the text builder.
+* #1024: Improve Makefile/make.bat error message if Sphinx is not found. Thanks
+ to Anatoly Techtonik.
+* #1018: Fix "container" directive handling in the text builder.
+* #1015: Stop overriding jQuery contains() in the JavaScript.
+* #1010: Make pngmath images transparent by default; IE7+ should handle it.
+* #1008: Fix test failures with Python 3.3.
+* #976: Fix gettext does not extract index entries.
+* PR#72: #975: Fix gettext not extracting definition terms before docutils 0.10.
+* #958: Do not preserve ``environment.pickle`` after a failed build.
+* #955: Fix i18n transformation.
+* #940: Fix gettext does not extract figure caption.
+* #920: Fix PIL packaging issue that allowed to import ``Image`` without PIL
+ namespace. Thanks to Marc Schlaich.
+* #440: Fix coarse timestamp resolution in some filesystem generating a wrong
+ list of outdated files.
+
Release 1.1.3 (Mar 10, 2012)
============================
From 63463eed979e692570dfc821da21d9661f7e16b4 Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:12:21 +0100
Subject: [PATCH 27/76] std domain: better name for local variable
---
sphinx/domains/std.py | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py
index 011a12bf3..8769309b8 100644
--- a/sphinx/domains/std.py
+++ b/sphinx/domains/std.py
@@ -307,13 +307,13 @@ class Glossary(Directive):
# add an index entry too
indexnode = addnodes.index()
indexnode['entries'] = [('single', termtext, new_id, 'main')]
- _termnodes = []
- _termnodes.append(indexnode)
- _termnodes.extend(res[0])
- _termnodes.append(addnodes.termsep())
- for termnode in _termnodes:
+ new_termnodes = []
+ new_termnodes.append(indexnode)
+ new_termnodes.extend(res[0])
+ new_termnodes.append(addnodes.termsep())
+ for termnode in new_termnodes:
termnode.source, termnode.line = source, lineno
- termnodes.extend(_termnodes)
+ termnodes.extend(new_termnodes)
# make a single "term" node with all the terms, separated by termsep
# nodes (remove the dangling trailing separator)
term = nodes.term('', '', *termnodes[:-1])
From 1d192dbe6ea977e940249c823ebf5a4c3722cdbd Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:34:57 +0100
Subject: [PATCH 28/76] nodes utils: remove monkey-patch that is in docutils
>=0.7
---
sphinx/util/nodes.py | 12 ------------
1 file changed, 12 deletions(-)
diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py
index 640ef4955..62ad5d773 100644
--- a/sphinx/util/nodes.py
+++ b/sphinx/util/nodes.py
@@ -216,18 +216,6 @@ def set_role_source_info(inliner, lineno, node):
# docutils 0.9+
node.source, node.line = inliner.reporter.get_source_and_line(lineno)
-# monkey-patch Node.__contains__ to get consistent "in" operator behavior
-# across docutils versions
-
-def _new_contains(self, key):
- # support both membership test for children and attributes
- # (has_key is translated to "in" by 2to3)
- if isinstance(key, basestring):
- return key in self.attributes
- return key in self.children
-
-nodes.Node.__contains__ = _new_contains
-
# monkey-patch Element.copy to copy the rawsource
def _new_copy(self):
From 3d0b924e70d9e17a9ce928417b507d221c5f7a7f Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:28:38 +0100
Subject: [PATCH 29/76] remove xfileref_role() and directive_dwim() which were
deprecated in 1.0
---
CHANGES | 6 +++++-
sphinx/roles.py | 8 --------
sphinx/util/compat.py | 10 ----------
3 files changed, 5 insertions(+), 19 deletions(-)
diff --git a/CHANGES b/CHANGES
index aa5e5ef39..e9a401f9c 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,7 +1,11 @@
Release 1.2 (in development)
============================
-There should be no backwards-incompatible changes in this version.
+Incompatible changes
+--------------------
+
+* Removed ``sphinx.util.compat.directive_dwim()`` and
+ ``sphinx.roles.xfileref_role()`` which were deprecated since version 1.0.
Features added
--------------
diff --git a/sphinx/roles.py b/sphinx/roles.py
index 02c5ad8fc..6703b6b8b 100644
--- a/sphinx/roles.py
+++ b/sphinx/roles.py
@@ -10,7 +10,6 @@
"""
import re
-import warnings
from docutils import nodes, utils
from docutils.parsers.rst import roles
@@ -316,10 +315,3 @@ specific_docroles = {
for rolename, func in specific_docroles.iteritems():
roles.register_local_role(rolename, func)
-
-
-# backwards compatibility alias
-def xfileref_role(*args, **kwds):
- warnings.warn('xfileref_role is deprecated, use XRefRole',
- DeprecationWarning, stacklevel=2)
- return XRefRole()(*args, **kwds)
diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py
index 916f6fa3b..946230799 100644
--- a/sphinx/util/compat.py
+++ b/sphinx/util/compat.py
@@ -33,14 +33,4 @@ def make_admonition(node_class, name, arguments, options, content, lineno,
state.nested_parse(content, content_offset, admonition_node)
return [admonition_node]
-
-# backwards-compatibility aliases for helpers in older Sphinx versions that
-# supported the docutils 0.4 directive function interface
-
from docutils.parsers.rst import Directive
-
-def directive_dwim(obj):
- import warnings
- warnings.warn('directive_dwim is deprecated and no longer needed',
- DeprecationWarning, stacklevel=2)
- return obj
From fddb49204459f41f3ca098e329033c5c7c089414 Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:31:14 +0100
Subject: [PATCH 30/76] all: provide docutils version in sphinx.util.compat
---
sphinx/__init__.py | 19 +++++++------------
sphinx/transforms.py | 14 ++++----------
sphinx/util/compat.py | 3 +++
3 files changed, 14 insertions(+), 22 deletions(-)
diff --git a/sphinx/__init__.py b/sphinx/__init__.py
index 0c68ad322..88d47cd11 100644
--- a/sphinx/__init__.py
+++ b/sphinx/__init__.py
@@ -39,19 +39,8 @@ if '+' in __version__ or 'pre' in __version__:
def main(argv=sys.argv):
"""Sphinx build "main" command-line entry."""
if sys.version_info[:3] < (2, 5, 0):
- sys.stderr.write('Error: Sphinx requires at least '
- 'Python 2.5 to run.\n')
+ sys.stderr.write('Error: Sphinx requires at least Python 2.5 to run.\n')
return 1
- if sys.version_info[:3] >= (3, 3, 0):
- try:
- import docutils
- x, y = docutils.__version__.split('.')[:2]
- if (int(x), int(y)) < (0, 10):
- sys.stderr.write('Error: Sphinx requires at least '
- 'Docutils 0.10 for Python 3.3 and above.\n')
- return 1
- except Exception:
- pass
try:
from sphinx import cmdline
except ImportError:
@@ -78,6 +67,12 @@ def main(argv=sys.argv):
sys.stderr.write(hint)
return 1
raise
+ if sys.version_info[:3] >= (3, 3, 0):
+ from sphinx.util.compat import docutils_version
+ if docutils_version < (0, 10):
+ sys.stderr.write('Error: Sphinx requires at least '
+ 'Docutils 0.10 for Python 3.3 and above.\n')
+ return 1
return cmdline.main(argv)
diff --git a/sphinx/transforms.py b/sphinx/transforms.py
index 97721eb5e..26495a099 100644
--- a/sphinx/transforms.py
+++ b/sphinx/transforms.py
@@ -22,6 +22,7 @@ from sphinx.locale import _, init as init_locale
from sphinx.util import split_index_msg
from sphinx.util.nodes import traverse_translatable_index, extract_messages
from sphinx.util.osutil import ustrftime, find_catalog
+from sphinx.util.compat import docutils_version
from sphinx.util.pycompat import all
@@ -131,21 +132,14 @@ class CustomLocaleReporter(object):
"""
Replacer for document.reporter.get_source_and_line method.
- reST text lines for translation not have original source line number.
- This class provide correct line number at reporting.
+ reST text lines for translation do not have the original source line number.
+ This class provides the correct line numbers when reporting.
"""
def __init__(self, source, line):
self.source, self.line = source, line
- try:
- from docutils import __version__ as du_version
- v = tuple([int(x) for x in du_version.split('.')[:2]])
- except ImportError:
- v = (99, 99)
- self.du_version = v
-
def set_reporter(self, document):
- if self.du_version < (0, 9):
+ if docutils_version < (0, 9):
document.reporter.locator = self.get_source_and_line
else:
document.reporter.get_source_and_line = self.get_source_and_line
diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py
index 946230799..4b7cbf6dc 100644
--- a/sphinx/util/compat.py
+++ b/sphinx/util/compat.py
@@ -11,6 +11,9 @@
from docutils import nodes
+from docutils import __version__ as _du_version
+docutils_version = tuple(int(x) for x in _du_version.split('.')[:2])
+
def make_admonition(node_class, name, arguments, options, content, lineno,
content_offset, block_text, state, state_machine):
#if not content:
From 2b5a1476c88e5464f385247c381d9f782ba693e4 Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:38:57 +0100
Subject: [PATCH 31/76] text writer: docstring proofreading
---
sphinx/writers/text.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py
index 14d7c9522..d2c2fcba8 100644
--- a/sphinx/writers/text.py
+++ b/sphinx/writers/text.py
@@ -32,8 +32,8 @@ class TextWrapper(textwrap.TextWrapper):
def _wrap_chunks(self, chunks):
"""_wrap_chunks(chunks : [string]) -> [string]
- Original _wrap_chunks use len() to calculate width.
- This method respect to wide/fullwidth characters for width adjustment.
+ The original _wrap_chunks uses len() to calculate width.
+ This method respects wide/fullwidth characters for width adjustment.
"""
drop_whitespace = getattr(self, 'drop_whitespace', True) #py25 compat
lines = []
From c010bf7cc29cf499824089dc03d22406d8c21b5f Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:47:42 +0100
Subject: [PATCH 32/76] locale: compile message catalogs
---
sphinx/locale/hu/LC_MESSAGES/sphinx.mo | Bin 8194 -> 8194 bytes
sphinx/locale/ru/LC_MESSAGES/sphinx.mo | Bin 11033 -> 11033 bytes
2 files changed, 0 insertions(+), 0 deletions(-)
diff --git a/sphinx/locale/hu/LC_MESSAGES/sphinx.mo b/sphinx/locale/hu/LC_MESSAGES/sphinx.mo
index 8e3614a3ff769742ed797e06d738f96eea566f0c..0eb33445d751053b45b901b946c57b3d6469bc7d 100644
GIT binary patch
delta 23
ecmZp2XmZ%FK#0p&*T_=A(8$WfeDf-y2wnhIW(K$b
delta 23
ecmZp2XmZ%FK#0po*T7uC(89{ZV)H7Y2wnhIVFtPY
diff --git a/sphinx/locale/ru/LC_MESSAGES/sphinx.mo b/sphinx/locale/ru/LC_MESSAGES/sphinx.mo
index 5a0cabce95c02e23f85cde8630805ccfeb1bfb54..04228e8b6712c932f9cf3a75093d4dd666cb548d 100644
GIT binary patch
delta 23
ecmbOkHZyF)X;Cg?T_Z~cLnA8_^UYU9T|@z4#0O#k
delta 23
ecmbOkHZyF)X;CgCT?2CkLklYti_KR>T|@z4zXxOh
From dea5b77bb369621481266f7b79e3c2c6c189a769 Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:49:53 +0100
Subject: [PATCH 33/76] docs: add versionadded to epub_use_index confval
---
doc/config.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/doc/config.rst b/doc/config.rst
index 882b30a03..a883e05b4 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -954,6 +954,8 @@ the `Dublin Core metadata `_.
:confval:`html_use_index` option but can be set independently for epub
creation.
+ .. versionadded:: 1.2
+
.. _latex-options:
Options for LaTeX output
From a765d4c4794eaafedc184c185f9f09fda4a9c2d4 Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:51:52 +0100
Subject: [PATCH 34/76] changelog: add missing entry for PR#122
---
CHANGES | 2 ++
1 file changed, 2 insertions(+)
diff --git a/CHANGES b/CHANGES
index e9a401f9c..5a00ded76 100644
--- a/CHANGES
+++ b/CHANGES
@@ -6,6 +6,8 @@ Incompatible changes
* Removed ``sphinx.util.compat.directive_dwim()`` and
``sphinx.roles.xfileref_role()`` which were deprecated since version 1.0.
+* PR#122: the files given in :confval:`latex_additional_files` now override TeX
+ files included by Sphinx, such as ``sphinx.sty``.
Features added
--------------
From 00beefb6d7c388a4240d6b5b9f1cdf4e8e64422f Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 12:55:58 +0100
Subject: [PATCH 35/76] changelog: add more backwards incompatible changes
---
CHANGES | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/CHANGES b/CHANGES
index 5a00ded76..78b1a24b9 100644
--- a/CHANGES
+++ b/CHANGES
@@ -8,6 +8,12 @@ Incompatible changes
``sphinx.roles.xfileref_role()`` which were deprecated since version 1.0.
* PR#122: the files given in :confval:`latex_additional_files` now override TeX
files included by Sphinx, such as ``sphinx.sty``.
+* PR#124: the node generated by :rst:dir:`versionadded`,
+ :rst:dir:`versionchanged` and :rst:dir:`deprecated` directives now includes
+ all added markup (such as "New in version X") as child nodes, and no
+ additional text must be generated by writers.
+* PR#99: the :rst:dir:`seealso` directive now generates admonition nodes instead
+ of the custom ``seealso`` node.
Features added
--------------
@@ -142,8 +148,8 @@ Bugs fixed
----------
* PR#124: Fix paragraphs in versionmodified are ignored when it has no
- dangling paragraphs. Fix wrong html output (nested ```` tag). Fix
- versionmodified is not translatable. Thanks to Nozomu Kaneko.
+ dangling paragraphs. Fix wrong html output (nested ``
`` tag). Fix
+ versionmodified is not translatable. Thanks to Nozomu Kaneko.
* PR#111: Respect add_autodoc_attrgetter() even when inherited-members is set.
Thanks to A. Jesse Jiryu Davis.
* PR#97: Fix footnote handling in translated documents.
From b0381f97f877f9c3c0d005dbabde24a4fd979714 Mon Sep 17 00:00:00 2001
From: Georg Brandl
Date: Fri, 29 Mar 2013 13:05:49 +0100
Subject: [PATCH 36/76] changelog: split off older changes (pre-1.0) to a
CHANGES.old file
---
CHANGES | 1251 +--------------------------------------------------
CHANGES.old | 1249 ++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 1254 insertions(+), 1246 deletions(-)
create mode 100644 CHANGES.old
diff --git a/CHANGES b/CHANGES
index 8ea3b270e..907d2b054 100644
--- a/CHANGES
+++ b/CHANGES
@@ -839,1250 +839,9 @@ Features added
"striptags" Jinja filter.
-Release 0.6.7 (Jun 05, 2010)
-============================
+Previous versions
+=================
-* #440: Remove usage of a Python >= 2.5 API in the ``literalinclude``
- directive.
-
-* Fix a bug that prevented some references being generated in the
- LaTeX builder.
-
-* #428: Add some missing CSS styles for standard docutils classes.
-
-* #432: Fix UnicodeErrors while building LaTeX in translated locale.
-
-
-Release 0.6.6 (May 25, 2010)
-============================
-
-* Handle raw nodes in the ``text`` writer.
-
-* Fix a problem the Qt help project generated by the ``qthelp``
- builder that would lead to no content being displayed in the Qt
- Assistant.
-
-* #393: Fix the usage of Unicode characters in mathematic formulas
- when using the ``pngmath`` extension.
-
-* #404: Make ``\and`` work properly in the author field of the
- ``latex_documents`` setting.
-
-* #409: Make the ``highlight_language`` config value work properly
- in the LaTeX builder.
-
-* #418: Allow relocation of the translation JavaScript files to
- the system directory on Unix systems.
-
-* #414: Fix handling of Windows newlines in files included with
- the ``literalinclude`` directive.
-
-* #377: Fix crash in linkcheck builder.
-
-* #387: Fix the display of search results in ``dirhtml`` output.
-
-* #376: In autodoc, fix display of parameter defaults containing
- backslashes.
-
-* #370: Fix handling of complex list item labels in LaTeX output.
-
-* #374: Make the ``doctest_path`` config value of the doctest
- extension actually work.
-
-* Fix the handling of multiple toctrees when creating the global
- TOC for the ``toctree()`` template function.
-
-* Fix the handling of hidden toctrees when creating the global TOC
- for the ``toctree()`` template function.
-
-* Fix the handling of nested lists in the text writer.
-
-* #362: In autodoc, check for the existence of ``__self__`` on
- function objects before accessing it.
-
-* #353: Strip leading and trailing whitespace when extracting
- search words in the search function.
-
-
-Release 0.6.5 (Mar 01, 2010)
-============================
-
-* In autodoc, fix the omission of some module members explicitly
- documented using documentation comments.
-
-* #345: Fix cropping of sidebar scroll bar with ``stickysidebar``
- option of the default theme.
-
-* #341: Always generate UNIX newlines in the quickstart Makefile.
-
-* #338: Fix running with ``-C`` under Windows.
-
-* In autodoc, allow customizing the signature of an object where
- the built-in mechanism fails.
-
-* #331: Fix output for enumerated lists with start values in LaTeX.
-
-* Make the ``start-after`` and ``end-before`` options to the
- ``literalinclude`` directive work correctly if not used together.
-
-* #321: Fix link generation in the LaTeX builder.
-
-
-Release 0.6.4 (Jan 12, 2010)
-============================
-
-* Improve the handling of non-Unicode strings in the configuration.
-
-* #316: Catch OSErrors occurring when calling graphviz with
- arguments it doesn't understand.
-
-* Restore compatibility with Pygments >= 1.2.
-
-* #295: Fix escaping of hyperref targets in LaTeX output.
-
-* #302: Fix links generated by the ``:doc:`` role for LaTeX output.
-
-* #286: collect todo nodes after the whole document has been read;
- this allows placing substitution references in todo items.
-
-* #294: do not ignore an explicit ``today`` config value in a
- LaTeX build.
-
-* The ``alt`` text of inheritance diagrams is now much cleaner.
-
-* Ignore images in section titles when generating link captions.
-
-* #310: support exception messages in the ``testoutput`` blocks of
- the ``doctest`` extension.
-
-* #293: line blocks are styled properly in HTML output.
-
-* #285: make the ``locale_dirs`` config value work again.
-
-* #303: ``html_context`` values given on the command line via ``-A``
- should not override other values given in conf.py.
-
-* Fix a bug preventing incremental rebuilds for the ``dirhtml``
- builder.
-
-* #299: Fix the mangling of quotes in some literal blocks.
-
-* #292: Fix path to the search index for the ``dirhtml`` builder.
-
-* Fix a Jython compatibility issue: make the dependence on the
- ``parser`` module optional.
-
-* #238: In autodoc, catch all errors that occur on module import,
- not just ``ImportError``.
-
-* Fix the handling of non-data, but non-method descriptors in autodoc.
-
-* When copying file times, ignore OSErrors raised by ``os.utime()``.
-
-
-Release 0.6.3 (Sep 03, 2009)
-============================
-
-* Properly add C module filenames as dependencies in autodoc.
-
-* #253: Ignore graphviz directives without content instead of
- raising an unhandled exception.
-
-* #241: Fix a crash building LaTeX output for documents that contain
- a todolist directive.
-
-* #252: Make it easier to change the build dir in the Makefiles
- generated by quickstart.
-
-* #220: Fix CSS so that displaymath really is centered.
-
-* #222: Allow the "Footnotes" header to be translated.
-
-* #225: Don't add whitespace in generated HTML after inline tags.
-
-* #227: Make ``literalinclude`` work when the document's path
- name contains non-ASCII characters.
-
-* #229: Fix autodoc failures with members that raise errors
- on ``getattr()``.
-
-* #205: When copying files, don't copy full stat info, only
- modification times.
-
-* #232: Support non-ASCII metadata in Qt help builder.
-
-* Properly format bullet lists nested in definition lists for LaTeX.
-
-* Section titles are now allowed inside ``only`` directives.
-
-* #201: Make ``centered`` directive work in LaTeX output.
-
-* #206: Refuse to overwrite an existing master document in
- sphinx-quickstart.
-
-* #208: Use MS-sanctioned locale settings, determined by the
- ``language`` config option, in the HTML help builder.
-
-* #210: Fix nesting of HTML tags for displayed math from pngmath
- extension.
-
-* #213: Fix centering of images in LaTeX output.
-
-* #211: Fix compatibility with docutils 0.5.
-
-
-Release 0.6.2 (Jun 16, 2009)
-============================
-
-* #130: Fix obscure IndexError in doctest extension.
-
-* #167: Make glossary sorting case-independent.
-
-* #196: Add a warning if an extension module doesn't have a
- ``setup()`` function.
-
-* #158: Allow '..' in template names, and absolute template paths;
- Jinja 2 by default disables both.
-
-* When highlighting Python code, ignore extra indentation before
- trying to parse it as Python.
-
-* #191: Don't escape the tilde in URIs in LaTeX.
-
-* Don't consider contents of source comments for the search index.
-
-* Set the default encoding to ``utf-8-sig`` to handle files with a
- UTF-8 BOM correctly.
-
-* #178: apply ``add_function_parentheses`` config value to C
- functions as promised.
-
-* #173: Respect the docutils ``title`` directive.
-
-* #172: The ``obj`` role now links to modules as promised.
-
-* #19: Tables now can have a "longtable" class, in order to get
- correctly broken into pages in LaTeX output.
-
-* Look for Sphinx message catalogs in the system default path before
- trying ``sphinx/locale``.
-
-* Fix the search for methods via "classname.methodname".
-
-* #155: Fix Python 2.4 compatibility: exceptions are old-style
- classes there.
-
-* #150: Fix display of the "sphinxdoc" theme on Internet Explorer
- versions 6 and 7.
-
-* #146: Don't fail to generate LaTeX when the user has an active
- ``.docutils`` configuration.
-
-* #29: Don't generate visible "-{-}" in option lists in LaTeX.
-
-* Fix cross-reference roles when put into substitutions.
-
-* Don't put image "alt" text into table-of-contents entries.
-
-* In the LaTeX writer, do not raise an exception on too many section
- levels, just use the "subparagraph" level for all of them.
-
-* #145: Fix autodoc problem with automatic members that refuse to be
- getattr()'d from their parent.
-
-* If specific filenames to build are given on the command line,
- check that they are within the source directory.
-
-* Fix autodoc crash for objects without a ``__name__``.
-
-* Fix intersphinx for installations without urllib2.HTTPSHandler.
-
-* #134: Fix pending_xref leftover nodes when using the todolist
- directive from the todo extension.
-
-
-Release 0.6.1 (Mar 26, 2009)
-============================
-
-* #135: Fix problems with LaTeX output and the graphviz extension.
-
-* #132: Include the autosummary "module" template in the distribution.
-
-
-Release 0.6 (Mar 24, 2009)
-==========================
-
-New features added
-------------------
-
-* Incompatible changes:
-
- - Templating now requires the Jinja2 library, which is an enhanced
- version of the old Jinja1 engine. Since the syntax and semantic
- is largely the same, very few fixes should be necessary in
- custom templates.
-
- - The "document" div tag has been moved out of the ``layout.html``
- template's "document" block, because the closing tag was already
- outside. If you overwrite this block, you need to remove your
- "document" div tag as well.
-
- - The ``autodoc_skip_member`` event now also gets to decide
- whether to skip members whose name starts with underscores.
- Previously, these members were always automatically skipped.
- Therefore, if you handle this event, add something like this
- to your event handler to restore the old behavior::
-
- if name.startswith('_'):
- return True
-
-* Theming support, see the new section in the documentation.
-
-* Markup:
-
- - Due to popular demand, added a ``:doc:`` role which directly
- links to another document without the need of creating a
- label to which a ``:ref:`` could link to.
-
- - #4: Added a ``:download:`` role that marks a non-document file
- for inclusion into the HTML output and links to it.
-
- - Added an ``only`` directive that can selectively include text
- based on enabled "tags". Tags can be given on the command
- line. Also, the current builder output format (e.g. "html" or
- "latex") is always a defined tag.
-
- - #10: Added HTML section numbers, enabled by giving a
- ``:numbered:`` flag to the ``toctree`` directive.
-
- - #114: Added an ``abbr`` role to markup abbreviations and
- acronyms.
-
- - The ``literalinclude`` directive now supports several more
- options, to include only parts of a file.
-
- - The ``toctree`` directive now supports a ``:hidden:`` flag,
- which will prevent links from being generated in place of
- the directive -- this allows you to define your document
- structure, but place the links yourself.
-
- - #123: The ``glossary`` directive now supports a ``:sorted:``
- flag that sorts glossary entries alphabetically.
-
- - Paths to images, literal include files and download files
- can now be absolute (like ``/images/foo.png``). They are
- treated as relative to the top source directory.
-
- - #52: There is now a ``hlist`` directive, creating a compact
- list by placing distributing items into multiple columns.
-
- - #77: If a description environment with info field list only
- contains one ``:param:`` entry, no bullet list is generated.
-
- - #6: Don't generate redundant ```` for top-level TOC tree
- items, which leads to a visual separation of TOC entries.
-
- - #23: Added a ``classmethod`` directive along with ``method``
- and ``staticmethod``.
-
- - Scaled images now get a link to the unscaled version.
-
- - SVG images are now supported in HTML (via ``