summaryrefslogtreecommitdiff
path: root/CHANGES
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-03-02 08:37:54 +0100
committerGeorg Brandl <georg@python.org>2014-03-02 08:37:54 +0100
commit4bf6795898b5156073cd243965b5a03c3b6c0536 (patch)
tree7f6b06b863e28bd69ddebc27db5f1260500dc1d3 /CHANGES
parent2d9105da52e65a255882870ba7c74a29c7b97e37 (diff)
parent3092cab9ecf55ae6704f2b170d37ae00e91e4b3e (diff)
downloadsphinx-4bf6795898b5156073cd243965b5a03c3b6c0536.tar.gz
merge with stable
Diffstat (limited to 'CHANGES')
-rw-r--r--CHANGES83
1 files changed, 51 insertions, 32 deletions
diff --git a/CHANGES b/CHANGES
index cbeb2a15..912d6960 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,41 +1,43 @@
-Release 1.2.2 (in development)
-==============================
-
-Bugs fixed
-----------
-
-* PR#211: When checking for existence of the :confval:`html_logo` file, check
- the full relative path and not the basename.
-* PR#212: Fix traceback with autodoc and ``__init__`` methods without docstring.
-* PR#213: Fix a missing import in the setup command.
-* #1357: Option names documented by :rst:dir:`option` are now again allowed to
- not start with a dash or slash, and referencing them will work correctly.
-* #1358: Fix handling of image paths outside of the source directory when using
- the "wildcard" style reference.
-* #1374: Fix for autosummary generating overly-long summaries if first line
- doesn't end with a period.
-* #1383: Fix Python 2.5 compatibility of sphinx-apidoc.
-* #1391: Actually prevent using "pngmath" and "mathjax" extensions at the same
- time in sphinx-quickstart.
-* #1386: Fix bug preventing more than one theme being added by the entry point
- mechanism.
-* #1370: Ignore "toctree" nodes in text writer, instead of raising.
-* #1364: Fix 'make gettext' fails when the '.. todolist::' directive is present.
-* #1367: Fix a change of PR#96 that break sphinx.util.docfields.Field.make_field
- interface/behavior for `item` argument usage.
-
-Documentation
--------------
-
-* Extended the :ref:`documentation about building extensions <dev-extensions>`.
+Release 1.3 (in development)
+============================
+Incompatible changes
+--------------------
-Release 1.2.1 (released Jan 19, 2014)
-=====================================
+* Dropped support for Python 2.5 and 3.1.
+* Dropped support for docutils versions up to 0.9.
+* Removed the ``sphinx.ext.oldcmarkup`` extension.
+* The deprecated config values ``exclude_trees``, ``exclude_dirnames`` and
+ ``unused_docs`` have been removed.
+* A new node, ``sphinx.addnodes.literal_strong``, has been added, for text that
+ should appear literally (i.e. no smart quotes) in strong font. Custom writers
+ will have to be adapted to handle this node.
+
+New features
+------------
+
+* Added ``sphinx.ext.napoleon`` extension for NumPy and Google style docstring
+ support.
+* PR#202: Allow "." and "~" prefixed references in ``:param:`` doc fields
+ for Python.
+* PR#184: Add :confval:`autodoc_mock_imports`, allowing to mock imports of
+ external modules that need not be present when autodocumenting.
+* #925: Allow list-typed config values to be provided on the command line,
+ like ``-D key=val1,val2``.
+* #668: Allow line numbering of ``code-block`` and ``literalinclude`` directives
+ to start at an arbitrary line number, with a new ``lineno-start`` option.
+* PR#172: The :rst:dir:`code-block` and :rst:dir:`literalinclude` directives now
+ can have a ``filename`` option that shows a filename before the code in the
+ output.
+* Prompt for the document language in sphinx-quickstart.
+* PR#217: Added config values to suppress UUID and location information in
+ generated gettext catalogs.
Bugs fixed
----------
+* #1174: Fix smart quotes being applied inside roles like :rst:role:`program` or
+ :rst:role:`makevar`.
* #1335: Fix autosummary template overloading with exclamation prefix like
``{% extends "!autosummary/class.rst" %}`` cause infinite recursive function
call. This was caused by PR#181.
@@ -113,11 +115,28 @@ Bugs fixed
* #1323: Fix emitting empty ``<ul>`` tags in the HTML writer, which is not
valid HTML.
* #1147: Don't emit a sidebar search box in the "singlehtml" builder.
+* PR#211: When checking for existence of the :confval:`html_logo` file, check
+ the full relative path and not the basename.
+* #1357: Option names documented by :rst:dir:`option` are now again allowed to
+ not start with a dash or slash, and referencing them will work correctly.
+* #1358: Fix handling of image paths outside of the source directory when using
+ the "wildcard" style reference.
+* #1374: Fix for autosummary generating overly-long summaries if first line
+ doesn't end with a period.
+* #1391: Actually prevent using "pngmath" and "mathjax" extensions at the same
+ time in sphinx-quickstart.
+* #1386: Fix bug preventing more than one theme being added by the entry point
+ mechanism.
+* #1370: Ignore "toctree" nodes in text writer, instead of raising.
+* #1364: Fix 'make gettext' fails when the '.. todolist::' directive is present.
+* #1367: Fix a change of PR#96 that break sphinx.util.docfields.Field.make_field
+ interface/behavior for `item` argument usage.
Documentation
-------------
* #1325: Added a "Intersphinx" tutorial section. (:file:`doc/tutorial.rst`)
+* Extended the :ref:`documentation about building extensions <dev-extensions>`.
Release 1.2 (released Dec 10, 2013)