From f1e5c46cd3f22cfc1f1a563844d6131ab9e10a67 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Tue, 30 Jul 2024 20:05:34 +0100 Subject: [PATCH] Move Sphinx 1.2 CHANGES to a dedicated file --- CHANGES.rst | 547 ------------------------------------------ doc/changes/1.2.rst | 547 ++++++++++++++++++++++++++++++++++++++++++ doc/changes/index.rst | 1 + 3 files changed, 548 insertions(+), 547 deletions(-) create mode 100644 doc/changes/1.2.rst diff --git a/CHANGES.rst b/CHANGES.rst index c63ec95dc..a7bd133cf 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -7250,550 +7250,3 @@ Documentation ------------- * Add clarification about the syntax of tags. (:file:`doc/markup/misc.rst`) - - -Release 1.2.3 (released Sep 1, 2014) -==================================== - -Features added --------------- - -* #1518: ``sphinx-apidoc`` command now has a ``--version`` option to show - version information and exit -* New locales: Hebrew, European Portuguese, Vietnamese. - -Bugs fixed ----------- - -* #636: Keep straight single quotes in literal blocks in the LaTeX build. -* #1419: Generated i18n sphinx.js files are missing message catalog entries - from '.js_t' and '.html'. The issue was introduced from Sphinx 1.1 -* #1363: Fix i18n: missing python domain's cross-references with currentmodule - directive or currentclass directive. -* #1444: autosummary does not create the description from attributes docstring. -* #1457: In python3 environment, make linkcheck cause "Can't convert 'bytes' - object to str implicitly" error when link target url has a hash part. - Thanks to Jorge_C. -* #1467: Exception on Python3 if nonexistent method is specified by automethod -* #1441: autosummary can't handle nested classes correctly. -* #1499: With non-callable ``setup`` in a conf.py, now sphinx-build emits - a user-friendly error message. -* #1502: In autodoc, fix display of parameter defaults containing backslashes. -* #1226: autodoc, autosummary: importing setup.py by automodule will invoke - setup process and execute ``sys.exit()``. Now Sphinx avoids SystemExit - exception and emits warnings without unexpected termination. -* #1503: py:function directive generate incorrectly signature when specifying - a default parameter with an empty list ``[]``. Thanks to Geert Jansen. -* #1508: Non-ASCII filename raise exception on make singlehtml, latex, man, - texinfo and changes. -* #1531: On Python3 environment, docutils.conf with 'source_link=true' in the - general section cause type error. -* PR#270, #1533: Non-ASCII docstring cause UnicodeDecodeError when uses with - inheritance-diagram directive. Thanks to WAKAYAMA shirou. -* PR#281, PR#282, #1509: TODO extension not compatible with websupport. Thanks - to Takeshi Komiya. -* #1477: gettext does not extract nodes.line in a table or list. -* #1544: ``make text`` generates wrong table when it has empty table cells. -* #1522: Footnotes from table get displayed twice in LaTeX. This problem has - been appeared from Sphinx 1.2.1 by #949. -* #508: Sphinx every time exit with zero when is invoked from setup.py command. - ex. ``python setup.py build_sphinx -b doctest`` return zero even if doctest - failed. - -Release 1.2.2 (released Mar 2, 2014) -==================================== - -Bugs fixed ----------- - -* PR#211: When checking for existence of the ``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 `. - - -Release 1.2.1 (released Jan 19, 2014) -===================================== - -Bugs fixed ----------- - -* #1335: Fix autosummary template overloading with exclamation prefix like - ``{% extends "!autosummary/class.rst" %}`` cause infinite recursive function - call. This was 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 ``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 - ``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 :dudir:`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 ``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. -* #848: Always take the newest code in incremental rebuilds with the - :mod:`sphinx.ext.viewcode` extension. -* #979, #1266: Fix exclude handling in ``sphinx-apidoc``. -* #1302: Fix regression in :mod:`sphinx.ext.inheritance_diagram` when - documenting classes that can't be pickled. -* #1316: Remove hard-coded ``font-face`` resources from epub theme. -* #1329: Fix traceback with empty translation msgstr in .po files. -* #1300: Fix references not working in translated documents in some instances. -* #1283: Fix a bug in the detection of changed files that would try to access - doctrees of deleted documents. -* #1330: Fix ``exclude_patterns`` behavior with subdirectories in the - ``html_static_path``. -* #1323: Fix emitting empty ``