Docutils

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

Docutils 0.10 is compatible with Python versions from 2.4 to 3.2.

* General:

- SmartQuotes transform for typographic quotes and dashes.

- ``docutils/math``, ``docutils/error_reporting.py``, and
``docutils/urischemes.py`` moved to the utils package.
Code importing these modules needs to adapt, e.g.::

try:
import docutils.math as math
except ImportError:
import docutils.utils.math as math

- enhanced math and error handling.

* docutils/io.py

- FileInput/FileOutput: no system-exit on IOError.
The `handle_io_errors` argument is ignored.

* docutils/writers/html4css1/__init__.py

- Use ``<code>`` tag for inline "code",
do not drop nested inline nodes (syntax highlight tokens).
- Customizable MathJax URL (based on patch by Dmitry Shachnev).
- No line break after opening inline math tag.

* docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py

- Fix section numbering by LaTeX.

* docutils/writers/s5_html/__init__.py

- Fix [ 3556388 ] Mathjax does not work with rst2s5.

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

.. Note::

Docutils 0.9.1 is the last version supporting Python 2.3.

* General:

Several fixes for Python 3 usage.

* docutils/setup.py

- Fix [ 3527842 ]. Under Python 3, converted tests and tools were
installed in the PYTHONPATH. Converted tests are now
stored in ``docutils/test3/``, tools no longer need conversion.

If you installed one of Docutils versions 0.7 ... 0.9 with
``setup.py install`` under Python 3, remove the spurious
``test/`` and ``tools/`` directories in the site library root.

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

* General:

- reStructuredText "code" role and directive with syntax highlighting
by Pygments_.
- "code" option of the "include" directive.

.. _Pygments: https://pygments.org/

- Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
characters and "international" quotes around inline markup.

- Fix handling of missing stylesheets.

* setup.py

- Fix [ 2971827 ] and [ 3442827 ]
extras/roman.py moved to docutils/utils/roman.py

* docutils/utils.py -> docutils/utils/__init__.py

- docutils.utils is now a package (providing a place for sub-modules)

* docutils/writers/html4css1/__init__.py

- change default for `math-output` setting to MathJax

* docutils/writers/latex2e/__init__.py

- Support the `abbreviation` and `acronym` standard roles.
- Record only files required to generate the LaTeX source as dependencies.
- Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
when suppressing LaTeX section numbering.

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

* General:

- Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
and [ 3395920 ] (correct copyright info for rst.el).

* docutils/writers/latex2e/__init__.py

- Clean up Babel language setting. Restores Sphinx compatibility.

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

* COPYING:

- Some additions to the Docutils core are released under the 2-Clause BSD
license.

* General:

- Handle language codes according to `BCP 47`_.
- If the specified language is not supported by Docutils,
warn and fall back to English.
- Math support: reStructuredText "math" role and directive,
``math`` and ``math_block`` doctree elements.
- Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.

.. _BCP 47: https://www.rfc-editor.org/rfc/bcp/bcp47.txt

* reStructuredText:

- most directives now support a "name" option that attaches a
reference name. So you can write ::

.. figure:: image.png
:name: figure name

as a short form of ::

.. _figure name:

.. figure:: image.png

Internationalization:

* Added lithuanian mappings.

Components:

* HTML writer:

- New setting "math-output" with support for HTML, MathML, and LaTeX.

* LaTeX2e writer:

- Convert image URI to a local file path.
- Apply [ 3148141 ] fix multicolumn support when a colspanning cell
has more than one paragraph (Wolfgang Scherer).

* XeTeX writer:

- New writer generating LaTeX code for compiling with ``xelatex``.

XeTeX uses unicode and modern font technologies.

* and fixes and enhancements here and there.

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

Components:

* HTML writer:

- Support SVG and SWF images (thanks to Stefan Rank).
- Generate valid XHTML for centered images with targets.
Use CSS classes instead of "align" tags for image alignment.

* LaTeX2e writer:

- Use the ``\url`` command for URLs (breaks long URLs instead of writing
into the margin).
- Preserve runs of spaces in 'inline literals'.
- Deprecate ``figure_footnotes`` setting.
- Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
- New ``latex_preamble`` setting.
- Use PDF standard fonts (Times/Helvetica/Courier) as default.
- `hyperref` package called with ``unicode`` option (see the
`hyperref config tips`__ for how to override).
- Drop the special `output_encoding`__ default ("latin-1").
The Docutils wide default (usually "UTF-8") is used instead.

__ docs/user/config.htmldocutils-footnotes
__ docs/user/latex.htmlhyperlinks
__ docs/user/latex.htmloutput-encoding

* manpage writer:

- Titles level 1, that is ``.SH``, always uppercase.
- Apply patch from mg: literal text should be bold in man-pages.

General:

* io.FileInput opens files as text files with universal newline support
(mode "rU", configurable with the new optional argument "mode").

* setup.py:

- Python 3 support: copy test/ and tools/ to the build-dir
and convert Python sources with 2to3.