diff options
Diffstat (limited to 'CHANGES')
| -rw-r--r-- | CHANGES | 132 |
1 files changed, 129 insertions, 3 deletions
@@ -6,6 +6,130 @@ Change support versions * Drop Python-2.5, 3.1 (support code was completely removed) +Incompatible changes +-------------------- + +* Removed the ``sphinx.ext.oldcmarkup`` extension. + +New features +------------ + +* PR#202: Allow "." and "~" prefixed references in ``:param:`` doc fields + for Python. + +* #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. + +* Prompt for the document language in sphinx-quickstart. + +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 caused by PR#181. + +* #1337: Fix autodoc with ``autoclass_content="both"`` uses useless + ``object.__init__`` docstring when class does not have ``__init__``. + This was caused by a change for #1138. + +* #1340: Can't search alphabetical words on the HTML quick search generated + with language='ja'. + +* #1319: Do not crash if the :confval:`html_logo` file does not exist. + +* #603: Do not use the HTML-ized title for building the search index (that + resulted in "literal" being found on every page with a literal in the + title). + +* #751: Allow production lists longer than a page in LaTeX by using longtable. + +* #764: Always look for stopwords lowercased in JS search. + +* #814: autodoc: Guard against strange type objects that don't have + ``__bases__``. + +* #932: autodoc: Do not crash if ``__doc__`` is not a string. + +* #933: Do not crash if an :rst:role:`option` value is malformed (contains + spaces but no option name). + +* #908: On Python 3, handle error messages from LaTeX correctly in the pngmath + extension. + +* #943: In autosummary, recognize "first sentences" to pull from the docstring + if they contain uppercase letters. + +* #923: Take the entire LaTeX document into account when caching + pngmath-generated images. This rebuilds them correctly when + :confval:`pngmath_latex_preamble` changes. + +* #901: Emit a warning when using docutils' new "math" markup without a Sphinx + math extension active. + +* #845: In code blocks, when the selected lexer fails, display line numbers + nevertheless if configured. + +* #929: Support parsed-literal blocks in LaTeX output correctly. + +* #949: Update the tabulary.sty packed with Sphinx. + +* #1050: Add anonymous labels into ``objects.inv`` to be referenced via + :mod:`~sphinx.ext.intersphinx`. + +* #1095: Fix print-media stylesheet being included always in the "scrolls" + theme. + +* #1085: Fix current classname not getting set if class description has + ``:noindex:`` set. + +* #1181: Report option errors in autodoc directives more gracefully. + +* #1155: Fix autodocumenting C-defined methods as attributes in Python 3. + +* #1233: Allow finding both Python classes and exceptions with the "class" and + "exc" roles in intersphinx. + +* #1198: Allow "image" for the "figwidth" option of the :rst:dir:`figure` + directive as documented by docutils. + +* #1152: Fix pycode parsing errors of Python 3 code by including two grammar + versions for Python 2 and 3, and loading the appropriate version for the + running Python version. + +* #1017: Be helpful and tell the user when the argument to :rst:dir:`option` + does not match the required format. + +* #1345: Fix two bugs with :confval:`nitpick_ignore`; now you don't have to + remove the store environment for changes to have effect. + +* #1072: In the JS search, fix issues searching for upper-cased words by + lowercasing words before stemming. + +* #1299: Make behavior of the :rst:dir:`math` directive more consistent and + avoid producing empty environments in LaTeX output. + +* #1308: Strip HTML tags from the content of "raw" nodes before feeding it + to the search indexer. + +* #1249: Fix duplicate LaTeX page numbering for manual documents. + +* #1292: In the linkchecker, retry HEAD requests when denied by HTTP 405. + Also make the redirect code apparent and tweak the output a bit to be + more obvious. + +* #1285: Avoid name clashes between C domain objects and section titles. + +Documentation +------------- + +* #1325: Added a "Intersphinx" tutorial section. (:file:`doc/tutorial.rst`) Release 1.2 (released Dec 10, 2013) @@ -28,8 +152,10 @@ Bugs fixed * Restore ``versionmodified`` CSS class for versionadded/changed and deprecated directives. -* Fix: `html_theme_path=['.']` is a trigger of rebuild all documents always - (This change keeps the current "theme changes cause a rebuild" feature). + +* PR#181: Fix `html_theme_path=['.']` is a trigger of rebuild all documents + always (This change keeps the current "theme changes cause a rebuild" + feature). * #1296: Fix invalid charset in HTML help generated HTML files for default locale. @@ -1027,4 +1153,4 @@ Previous versions The changelog for versions before 1.0 can be found in the file ``CHANGES.old`` in the source distribution or `at BitBucket -<http://bitbucket.org/birkenfeld/sphinx/raw/tip/CHANGES.old>`__. +<https://bitbucket.org/birkenfeld/sphinx/raw/tip/CHANGES.old>`__. |