Docutils

=========================

Docutils 0.16.x supports Python 2.7 and Python >= 3.5 natively,
without the use of the ``2to3`` tool.

* reStructuredText:

- Keep `backslash escapes`__ in the document tree. This allows, e.g.,
escaping of author-separators in `bibliographic fields`__.

__ https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism
__ docs/ref/rst/restructuredtext.htmlbibliographic-fields

* LaTeX writer:

- Informal titles of type "rubric" default to bold-italic and left aligned.
- Deprecate ``\docutilsrole`` prefix for styling commands:
use ``\DUrole`` instead.
- Fix topic subtitle.
- Add "latex writers" to the `config_section_dependencies`.
- Ignore classes for `rubric` elements
(class wrapper interferes with LaTeX formatting).

* tools/buildhtml.py

- New option ``--html-writer`` allows to select "html" (default),
"html4" or "html5" (deprecated in favour of the `"writer" setting`_
in Docutils 0.18).

* docutils/io.py

- Remove the `handle_io_errors` argument from io.FileInput/Output.

* docutils/nodes.py

- If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.

* Various bugfixes and improvements (see HISTORY_).

.. _"writer" setting: docs/user/config.htmlwriter-buildhtml-application
.. _auto_id_prefix: docs/user/config.htmlauto-id-prefix

=========================

Docutils 0.15.x is compatible with Python versions 2.6, 2.7 and 3.3 to 3.5.

.. Note::

Docutils 0.15.x is the last version supporting Python 2.6, 3.3 and 3.4.

* reStructuredText:

- Allow embedded colons in field list field names (before, tokens like
``:this:example:`` were considered ordinary text).

- Fixed a bug with the "trim" options of the "unicode" directive.

* languages: Added Korean localisation (ko).

=========================

.. Note::

Docutils 0.14.x is the last version supporting Python 2.4, 2.5,
3.1, and 3.2.

* docutils/docs/ref/docutils.dtd:

- Enable validation of Docutils XML documents against the DTD:

* docutils/parsers/rst/:

- Added functionality: escaped whitespace in URI contexts.
- Consistent handling of all whitespace characters in inline markup
recognition. (May break documents that relied on some whitespace
characters (NBSP, ...) *not* to be recognized as whitespace.)

* docutils/utils/smartquotes.py:

- Update quote definitions for et, fi, fr, ro, sv, tr, uk.
- Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
- Differentiate apostrophe from closing single quote (if possible).
- Add command line interface for stand-alone use (requires 2.7).

* docutils/writers/_html_base:

- Provide default title in metadata.
- The MathJax CDN shut down on April 30, 2017. For security reasons, we
don't use a third party public installation as default but warn
if `math-output` is set to MathJax without specifying a URL.
See math-output_ for details.

* docutils/writers/html4css1:

- Respect automatic table column sizing.

* docutils/writers/latex2e/__init__.py

- Handle class arguments for block-level elements by wrapping them
in a "DUclass" environment. This replaces the special handling for
"epigraph" and "topic" elements.

* docutils/writers/odf_odt:

- Language option sets ODF document's default language
- Image width, scale, ... set image size in generated ODF.

* tools/

- New front-end ``rst2html4.py``.

===========================

* docutils/writers/html5_polyglot

- New HTML writer generating `HTML 5`_.

* tools/

- New front-end ``rst2html5.py``.

* languages: persian/farsi (fa) and latvian (la) mappings.

* change default base url for :rfc: to http://tools.ietf.org/html/

* tables accept widths, a list and align

* latex2e: Fix admonition width, remove deprecated options,
better tablewidth auto, ...

* rst.el: The problem with ``electric-indent-mode`` has been fixed.

.. _HTML 5: https://www.w3.org/TR/html5/

=========================

Small changes only, release current state

=========================

* General

- Apply [ 2714873 ] Fix for the overwriting of document attributes.
- Support embedded aliases within hyperlink references.
- Fix [ 228 ] try local import of docutils components (reader, writer, parser,
language module) before global search.

* docutils/parsers/rst/directives/tables.py

- Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.

* docutils/writers/html4css1/__init__.py
- Fix [ 3600051 ] for tables in a list, table cells are not compacted.
- New setting `stylesheet_dirs` (see above).

Now, it is easy to add a custom stylesheet to Docutils' default
stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``

Changed behaviour of the default settings:
if there is a file ``html4css1.css`` in the working directory of the
process at launch, it is used instead of the one provided by Docutils
in the writer source directory.

- New default for math-output_: ``HTML math.css``.
- Avoid repeated class declarations in html4css1 writer
(modified version of patch [ 104 ]).

* docutils/writers/latex2e/__init__.py

- Drop the simple algorithm replacing straight double quotes with
English typographic ones.
Activate the SmartQuotes_ transform if you want this feature.
- New setting `stylesheet_dirs`: Comma-separated list of directories
where stylesheets are found. Used by `stylesheet_path` when expanding
relative path arguments.

* docutils/writers/manpage.py

- Fix [3607063] handle lines starting with a period.
- Fix option separating comma was bold (thanks to Bill Morris).

.. _math-output: docs/user/config.htmlmath-output
.. _SmartQuotes: docs/user/config.htmlsmart-quotes