CINXE.COM

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="utf-8" /> <meta name="generator" content="Docutils 0.22b.dev: https://docutils.sourceforge.io/" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="dcterms.date" content="2024-11-12" /> <meta name="dcterms.rights" content="This document has been placed in the public domain." /> <title>Docutils Release Notes</title> <link rel="schema.dcterms" href="http://purl.org/dc/terms/"/> <link rel="stylesheet" href="docutils/writers/html5_polyglot/minimal.css" type="text/css" /> <link rel="stylesheet" href="docutils/writers/html5_polyglot/responsive.css" type="text/css" /> <link rel="stylesheet" href="docutils/writers/html5_polyglot/italic-field-names.css" type="text/css" /> </head> <body class="with-toc"> <header> <a class="reference external" href="https://docutils.sourceforge.io">Docutils</a> | <a class="reference external" href="docs/index.html">Overview</a> | <a class="reference external" href="docs/index.html#project-fundamentals">About</a> | <a class="reference external" href="docs/index.html#user">Users</a> | <a class="reference external" href="docs/index.html#ref">Reference</a> | <a class="reference external" href="docs/index.html#howto">Developers</a> </header> <main id="docutils-release-notes"> <h1 class="title">Docutils Release Notes</h1> <dl class="docinfo"> <dt class="contact">Contact:</dt> <dd class="contact"><a class="reference external" href="mailto:grubert@users.sourceforge.net">grubert@users.sourceforge.net</a></dd> <dt class="maintainer">Maintainer:</dt> <dd class="maintainer"><a class="reference external" href="mailto:docutils-develop@lists.sourceforge.net">docutils-develop@lists.sourceforge.net</a> </dd> <dt class="date">Date:</dt> <dd class="date">2024-11-12</dd> <dt class="revision">Revision:</dt> <dd class="revision">9980</dd> <dt class="web-site">Web site:</dt> <dd class="web-site"><a class="reference external" href="https://docutils.sourceforge.io/">https://docutils.sourceforge.io/</a> </dd> <dt class="copyright">Copyright:</dt> <dd class="copyright">This document has been placed in the public domain.</dd> </dl>  This document summarizes the major changes in previous and upcoming releases. For a more detailed list of changes, please see the Docutils <a class="reference external" href="HISTORY.html">HISTORY</a>. <nav class="contents" id="contents" role="doc-toc"> <a class="reference internal" href="#top">Contents</a> <ul class="simple"> <li><a class="reference internal" href="#future-changes" id="toc-entry-1">Future changes</a> <ul> <li><a class="reference internal" href="#command-line-interface" id="toc-entry-2">Command line interface</a></li> <li><a class="reference internal" href="#document-tree-docutils-dtd" id="toc-entry-3">Document Tree / Docutils DTD</a></li> <li><a class="reference internal" href="#writers" id="toc-entry-4">Writers</a></li> <li><a class="reference internal" href="#removals" id="toc-entry-5">Removals</a></li> <li><a class="reference internal" href="#misc" id="toc-entry-6">Misc</a></li> </ul> </li> <li><a class="reference internal" href="#release-0-22b-dev-unpublished" id="toc-entry-7">Release 0.22b.dev (unpublished)</a></li> <li><a class="reference internal" href="#release-0-21-2-2024-04-23" id="toc-entry-8">Release 0.21.2 (2024-04-23)</a></li> <li><a class="reference internal" href="#release-0-21-1-2024-04-10" id="toc-entry-9">Release 0.21.1 (2024-04-10)</a></li> <li><a class="reference internal" href="#release-0-21-2024-04-09" id="toc-entry-10">Release 0.21 (2024-04-09)</a></li> <li><a class="reference internal" href="#release-0-20-1-2023-05-17" id="toc-entry-11">Release 0.20.1 (2023-05-17)</a></li> <li><a class="reference internal" href="#release-0-20-2023-05-04" id="toc-entry-12">Release 0.20 (2023-05-04)</a></li> <li><a class="reference internal" href="#release-0-19-2022-07-05" id="toc-entry-13">Release 0.19 (2022-07-05)</a></li> <li><a class="reference internal" href="#release-0-18-1-2021-12-23" id="toc-entry-14">Release 0.18.1 (2021-12-23)</a></li> <li><a class="reference internal" href="#release-0-18-2021-10-26" id="toc-entry-15">Release 0.18 (2021-10-26)</a></li> <li><a class="reference internal" href="#release-0-17-1-2021-04-16" id="toc-entry-16">Release 0.17.1 (2021-04-16)</a></li> <li><a class="reference internal" href="#release-0-17-2021-04-03" id="toc-entry-17">Release 0.17 (2021-04-03)</a></li> <li><a class="reference internal" href="#release-0-16-2020-01-12" id="toc-entry-18">Release 0.16 (2020-01-12)</a></li> <li><a class="reference internal" href="#release-0-15-2019-07-20" id="toc-entry-19">Release 0.15 (2019-07-20)</a></li> <li><a class="reference internal" href="#release-0-14-2017-08-03" id="toc-entry-20">Release 0.14 (2017-08-03)</a></li> <li><a class="reference internal" href="#release-0-13-1-2016-12-09" id="toc-entry-21">Release 0.13.1 (2016-12-09)</a></li> <li><a class="reference internal" href="#release-0-12-2014-07-06" id="toc-entry-22">Release 0.12 (2014-07-06)</a></li> <li><a class="reference internal" href="#release-0-11-2013-07-22" id="toc-entry-23">Release 0.11 (2013-07-22)</a></li> <li><a class="reference internal" href="#release-0-10-2012-12-16" id="toc-entry-24">Release 0.10 (2012-12-16)</a></li> <li><a class="reference internal" href="#release-0-9-1-2012-06-17" id="toc-entry-25">Release 0.9.1 (2012-06-17)</a></li> <li><a class="reference internal" href="#release-0-9-2012-05-02" id="toc-entry-26">Release 0.9 (2012-05-02)</a></li> <li><a class="reference internal" href="#release-0-8-1-2011-08-30" id="toc-entry-27">Release 0.8.1 (2011-08-30)</a></li> <li><a class="reference internal" href="#release-0-8-2011-07-07" id="toc-entry-28">Release 0.8 (2011-07-07)</a></li> <li><a class="reference internal" href="#release-0-7-2010-07-07" id="toc-entry-29">Release 0.7 (2010-07-07)</a></li> <li><a class="reference internal" href="#release-0-6-2009-10-11" id="toc-entry-30">Release 0.6 (2009-10-11)</a></li> <li><a class="reference internal" href="#release-0-5-2008-06-25" id="toc-entry-31">Release 0.5 (2008-06-25)</a></li> <li><a class="reference internal" href="#release-0-4-2006-01-09" id="toc-entry-32">Release 0.4 (2006-01-09)</a></li> <li><a class="reference internal" href="#release-0-3-9-2005-05-26" id="toc-entry-33">Release 0.3.9 (2005-05-26)</a></li> <li><a class="reference internal" href="#release-0-3-7-2004-12-24" id="toc-entry-34">Release 0.3.7 (2004-12-24)</a></li> <li><a class="reference internal" href="#release-0-3-5-2004-07-29" id="toc-entry-35">Release 0.3.5 (2004-07-29)</a></li> </ul> </nav> <section id="future-changes"> <h2><a class="toc-backref" href="#toc-entry-1" role="doc-backlink">Future changes</a><a class="self-link" title="link to this section" href="#future-changes"></a></h2> <section id="command-line-interface"> <h3><a class="toc-backref" href="#toc-entry-2" role="doc-backlink">Command line interface</a><a class="self-link" title="link to this section" href="#command-line-interface"></a></h3> <ul> <li>The command-line usage pattern will change: <pre class="code diff literal-block"><code>- COMMAND [OPTIONS] [SOURCE [DESTINATION]] + COMMAND [OPTIONS] [SOURCE [SOURCE2 [...]]]</code></pre> <ul class="simple"> <li>Stop accepting the DESTINATION positional argument in Docutils聽1.0. Use --output=DESTINATION (cf. the "<a class="reference external" href="docs/user/config.html#output">output</a>" configuration setting) or output redirection.</li> <li>Accept the short option -o for --output in Docutils聽1.0</li> <li>Accept more than one source document in Docutils聽2.0</li> </ul> For the rationale, see <a class="reference external" href="https://clig.dev/#arguments-and-flags">https://clig.dev/#arguments-and-flags</a>. </li> </ul> </section> <section id="document-tree-docutils-dtd"> <h3><a class="toc-backref" href="#toc-entry-3" role="doc-backlink">Document Tree / Docutils DTD</a><a class="self-link" title="link to this section" href="#document-tree-docutils-dtd"></a></h3> <ul> <li>Do not lowercase reference names in the <a class="reference external" href="docs/ref/doctree.html#refname">"refname" attribute</a> (matching hyperlinks, footnotes, and citations remains case insensitive), and drop the name attribute from <reference> nodes in Docutils聽1.0.</li> <li>Use the %tbl.table.att parameter entity instead of %bodyatt to customize the <table> element's attribute list in Docutils聽1.0.</li> <li>The <footnote> element's first child (<label>) will become mandatory in Docutils聽1.0.</li> <li>Values of the <a class="reference external" href="docs/ref/doctree.html#colwidth">"colwidth" attribute</a> will be stored in Python element instances as <cite>str</cite> (with unit "*" for proportional values) in Docutils聽1.0. (The method <cite>nodes.colspec.propwidth()</cite> provides a stable means to extract a proportionional value as number.) The default unit will change to "pt" in Docutils聽2.0. </li> <li>The <a class="reference external" href="docs/ref/doctree.html#doctest-block"><doctest_block></a> element will be deprecated in Docutils聽1.0. The rST parser will handle a <a class="reference external" href="docs/ref/rst/restructuredtext.html#doctest-blocks">doctest block</a> similar to a "code" directive with language "pycon" (Python console) and generate a <literal_block>.</li> </ul> </section> <section id="writers"> <h3><a class="toc-backref" href="#toc-entry-4" role="doc-backlink">Writers</a><a class="self-link" title="link to this section" href="#writers"></a></h3> <ul> <li>The <a class="reference external" href="docs/user/html.html#html">default HTML writer</a> will change in Docutils聽2.0: The <a class="reference external" href="docs/user/tools.html#rst2html">rst2html</a> front end and get_writer_by_name('html') select "html4css1" now and will select "html5" in Docutils聽2.0 and later. <ul class="simple"> <li>Use <a class="reference external" href="docs/user/tools.html#rst2html4">rst2html4</a>, docutils --writer=html4, or get_writer_by_name('html4') if you depend on stability of the generated HTML code, e.g. because you use a custom style sheet or post-processing that may break otherwise.</li> <li>Use <a class="reference external" href="docs/user/tools.html#rst2html5">rst2html5</a>, docutils or get_writer_by_name('html5') if you want a HTML5 document.</li> </ul> </li> <li>"html5" writer: <ul class="simple"> <li>Move attribution behind the blockquote to comply with the <a class="reference external" href="https://html.spec.whatwg.org/#the-blockquote-element">"HTML living standard"</a>. (The now retired <a class="reference external" href="https://www.w3.org/TR/2014/REC-html5-20141028/grouping-content.html#the-blockquote-element">HTML5</a> W3C recommendation allows <cite> elements inside a blockquote.) </li> <li>Change the default value of the <a class="reference external" href="docs/user/config.html#initial-header-level">initial_header_level</a> setting to None (<h2> if there is a document title, else <h1>) in Docutils聽1.0.</li> <li>Remove option --embed-images (obsoleted by "<a class="reference external" href="docs/user/config.html#image-loading">image_loading</a>") in Docutils聽2.0.</li> </ul> </li> <li>"latex2e" writer: <ul class="simple"> <li>Change default of <a class="reference external" href="docs/user/config.html#use-latex-citations">use_latex_citations</a> setting to True in Docutils聽1.0.</li> <li>Change default of <a class="reference external" href="docs/user/config.html#legacy-column-widths">legacy_column_widths</a> setting to False in Docutils聽1.0.</li> <li>Remove use_verbatim_when_possible setting (use <a class="reference external" href="docs/user/config.html#literal-block-env">literal_block_env</a>: verbatim) in Docutils聽2.0.</li> <li>The <a class="reference external" href="docs/user/latex.html#length-units">default length unit</a> will change from "bp" (DTP point) to "px" (pixel unit) in Docutils聽1.0. </li> </ul> </li> </ul> </section> <section id="removals"> <h3><a class="toc-backref" href="#toc-entry-5" role="doc-backlink">Removals</a><a class="self-link" title="link to this section" href="#removals"></a></h3> <ul class="simple"> <li>Remove <cite>io.BinaryFileOutput</cite> and <cite>core.publish_cmdline_to_binary()</cite> in Docutils聽0.24.</li> <li>Remove <cite>writers.latex2e.SortableDict</cite> in Docutils聽0.24.</li> <li>Remove <cite>parsers.rst.directives.length_units</cite> in Docutils聽0.24. Use <cite>parsers.rst.directives.CSS3_LENGTH_UNITS</cite>. Mind that this is a tuple, not a list.</li> <li>Remove <cite>parsers.rst.directives.CSVTable.HeaderDialect</cite> in Docutils聽1.0.</li> <li>Remove support for the <a class="reference external" href="docs/user/config.html#recommonmark-parser">recommonmark parser</a> in Docutils聽1.0. Recommonmark is unmaintained since 2021 and deprecated in favour of the <a class="reference external" href="docs/user/config.html#myst-parser">MyST parser</a>. </li> <li>Remove the input encoding auto-detection code in Docutils聽1.0.</li> <li>Remove <cite>parsers.rst.roles.set_classes()</cite> and <cite>parsers.rst.roles.normalized_role_options()</cite> in Docutils聽1.0.</li> <li>Remove the "rawsource" argument from <cite>nodes.Text.__init__()</cite> in Docutils聽2.0.</li> <li>Remove attributes <cite>nodes.Element.known_attributes</cite>, <cite>nodes.Element.basic_attributes</cite>, and <cite>nodes.Element.local_attributes</cite>, in Docutils聽2.0.</li> <li>Drop support for <a class="reference external" href="docs/user/config.html#old-format-configuration-files">old-format configuration files</a> in Docutils聽2.0.</li> <li>Remove the --html-writer option of the <a class="reference external" href="docs/user/tools.html#buildhtml-py">buildhtml.py</a> application (obsoleted by the <a class="reference external" href="docs/user/config.html#writer-buildhtml-application">"writer" setting</a> since Docutils聽0.18) in Docutils聽2.0.</li> <li>Remove the "reader_name", "parser_name", and "writer_name" arguments of <cite>core.Publisher.__init__()</cite> and the <cite>core.publish_*()</cite> convenience functions in Docutils聽2.0. Since Docutils聽0.22, you may use "reader", "parser", and "writer" arguments for component names as well as instances.</li> </ul> </section> <section id="misc"> <h3><a class="toc-backref" href="#toc-entry-6" role="doc-backlink">Misc</a><a class="self-link" title="link to this section" href="#misc"></a></h3> <ul class="simple"> <li>Revise the <a class="reference external" href="docs/api/publisher.html#string-i-o">String I/O</a> interface used by the <cite>publish_string()</cite> and <cite>publish_from_doctree()</cite> publisher convenience functions. (In Python 3, name and behaviour no longer match.) </li> <li>Move math format conversion from docutils/utils/math (called from docutils/writers/_html_base.py) to a <a class="reference external" href="docs/ref/transforms.html">transform</a>. </li> </ul> </section> </section> <section id="release-0-22b-dev-unpublished"> <h2><a class="toc-backref" href="#toc-entry-7" role="doc-backlink">Release 0.22b.dev (unpublished)</a><a class="self-link" title="link to this section" href="#release-0-22b-dev-unpublished"></a></h2> <dl> <dt>reStructuredText:</dt> <dd>Support <a class="reference external" href="https://www.w3.org/TR/css-values-3/#lengths">CSS3 units</a>. This adds "ch", "rem", "vw", "vh", "vmin", "vmax", and "Q" to the <a class="reference external" href="docs/ref/rst/restructuredtext.html#length-units">supported length units</a>. Note that some output formats don't support all units. </dd> <dt>Document Tree / Docutils DTD</dt> <dd><ul class="simple"> <li>Allow multiple <term> elements in a <a class="reference external" href="docs/ref/doctree.html#definition-list-item"><definition_list_item></a> (third-party writers may need adaption).</li> </ul> </dd> <dt>Configuration changes</dt> <dd><ul class="simple"> <li>Make MathML the default <a class="reference external" href="docs/user/config.html#math-output">math_output</a> for the "html5" writer.</li> <li>Change the default input encoding from None (auto-detect) to "utf-8".</li> <li>Drop short options -i and -o. Use the long equivalents --input-encoding and --output-encoding. (See <a class="reference internal" href="#command-line-interface">command line interface</a> for the rationale.)</li> </ul> </dd> <dt>Output changes</dt> <dd><dl> <dt>LaTeX:</dt> <dd>Don't wrap references with custom <a class="reference external" href="docs/user/config.html#reference-label">reference-label</a> in a \hyperref command. The "hyperref" package generates hyperlinks for labels by default, so there is no change in the PDF (except for "ref*"). Stop requiring "ifthen.sty". Replace use of \ifthenelse{\isundefined... with the eTeX primitive \ifdefined. </dd> <dt>HTML5:</dt> <dd>Unitless <a class="reference external" href="docs/ref/rst/directives.html#image">image</a> size <a class="reference external" href="docs/ref/doctree.html#measure">measures</a> are written as <img> "width" and "hight" values instead of "style" rules. The current behaviour is kept for values with units, so users may specify, e.g. :width: 50px instead of :width: 50 to override CSS stylesheet rules. </dd> <dt>manpage:</dt> <dd>Don't UPPERCASE section headings. </dd> <dt>null:</dt> <dd>The "null" writer output changed from None to the empty string. <cite>publish_string()</cite> now returns a <cite>bytes</cite> or <cite>str</cite> instance for all writers (as documented). </dd> </dl> </dd> <dt>New objects</dt> <dd><dl> <dt><cite>parsers.docutils_xml</cite></dt> <dd>parser for <a class="reference external" href="docs/ref/doctree.html">Docutils XML</a> (e.g., the output of the "xml" writer). Provisional. Try docutils --parser=xml test/data/multiple-term-definitions.xml or use the :parser: option of the <a class="reference external" href="docs/ref/rst/directives.html#including-an-external-document-fragment">"include" directive</a> to include an XML file in a rST document. </dd> <dt><cite>nodes.Element.validate()</cite></dt> <dd>Raise <cite>nodes.ValidationError</cite> if the element does not comply with the <a class="reference external" href="docs/ref/doctree.html">Docutils Document Model</a>. Provisional. </dd> </dl> </dd> <dt>Removed objects</dt> <dd><dl class="simple"> <dt><cite>docutils.core.Publisher.setup_option_parser()</cite></dt> <dd>internal, obsolete, </dd> <dt><cite>docutils.frontend.OptionParser.set_defaults_from_dict()</cite></dt> <dd>obsolete, </dd> <dt><cite>docutils.nodes.Element.set_class()</cite></dt> <dd>obsolete, append to Element['classes'] directly, </dd> <dt><cite>docutils.parsers.rst.directives.tables.CSVTable.decode_from_csv()</cite></dt> <dd>not required with Python聽3, </dd> <dt><cite>docutils.parsers.rst.directives.tables.CSVTable.encode_from_csv()</cite></dt> <dd>not required with Python聽3, </dd> <dt><cite>docutils.transforms.writer_aux.Compound</cite></dt> <dd>not used since Dec 2010, </dd> <dt><cite>docutils.utils.error_reporting</cite></dt> <dd>obsolete in Python聽3, </dd> <dt><cite>docutils.utils.Reporter.set_conditions()</cite></dt> <dd>obsolete, set attributes via configuration settings or directly. </dd> </dl> </dd> <dt>Removed localisations:</dt> <dd><dl class="simple"> <dt>Mistranslations of the "admonition" directive name:</dt> <dd>Use "advies"聽(af), "varsel"聽(da), "warnhinweis"聽(de), "aviso"聽(es), "sciigo"聽(eo), "annonce"聽(fr), "avviso"聽(it), "advies"聽(nl), "zauwa偶enie"聽(pl) (introduced in Docutils聽0.21) or the English name "admonition". </dd> </dl> </dd> <dt>Removed files</dt> <dd><dl class="simple"> <dt>tools/rst2odt_prepstyles.py</dt> <dd>Obsoleted by <cite>docutils.writers.odf_odt.prepstyles</cite>. </dd> <dt>docutils/utils/roman.py</dt> <dd>Obsoleted by docutils/utils/_roman_numerals.py </dd> </dl> </dd> </dl> Bugfixes and improvements (see <a class="reference external" href="HISTORY.html">HISTORY</a>). </section> <section id="release-0-21-2-2024-04-23"> <h2><a class="toc-backref" href="#toc-entry-8" role="doc-backlink">Release 0.21.2 (2024-04-23)</a><a class="self-link" title="link to this section" href="#release-0-21-2-2024-04-23"></a></h2> <ul class="simple"> <li>Document Tree / Docutils DTD <ul> <li>Remove declaration of unsupported element <info>.</li> <li>Remove <decoration> from content declaration of <section> elements.</li> </ul> </li> <li>Declare support for languages Georgian and Catalan (Valencian).</li> <li>Fix test failures.</li> </ul> </section> <section id="release-0-21-1-2024-04-10"> <h2><a class="toc-backref" href="#toc-entry-9" role="doc-backlink">Release 0.21.1 (2024-04-10)</a><a class="self-link" title="link to this section" href="#release-0-21-1-2024-04-10"></a></h2> Add missing metadata files to sdist. No changes to the code. </section> <section id="release-0-21-2024-04-09"> <h2><a class="toc-backref" href="#toc-entry-10" role="doc-backlink">Release 0.21 (2024-04-09)</a><a class="self-link" title="link to this section" href="#release-0-21-2024-04-09"></a></h2> <ul> <li>General: <ul> <li>Drop support for Python聽3.7 and 3.8.</li> <li>Provide rst2* "console_scripts" <a class="reference external" href="https://packaging.python.org/en/latest/specifications/entry-points/">entry points</a> (without the .py extension) instead of installing the rst2*.py <a class="reference external" href="docs/user/tools.html">front end tools</a> in the binary PATH. <a class="brackets" href="#footnote-1" id="footnote-reference-1" role="doc-noteref">[1]</a> Exceptions: rstpep2html.py and rst2odt_prepstyles.py: <ul class="simple"> <li>Use docutils --reader=pep --writer=pep_html for a PEP preview. <a class="brackets" href="#footnote-2" id="footnote-reference-2" role="doc-noteref">[2]</a></li> <li>Use python -m docutils.writers.odf_odt.prepstyles to <a class="reference external" href="docs/user/odt.html#page-size">strip the page size</a> from an ODT writer stylesheet.</li> </ul> </li> </ul> <aside class="footnote-list brackets"> <aside class="footnote brackets" id="footnote-1" role="doc-footnote"> [<a role="doc-backlink" href="#footnote-reference-1">1</a>] Some Linux distributions already use the short names. </aside> <aside class="footnote brackets" id="footnote-2" role="doc-footnote"> [<a role="doc-backlink" href="#footnote-reference-2">2</a>] The final rendering is done by a Sphinx-based build system (cf. <a class="reference external" href="https://peps.python.org/pep-0676">PEP 676</a>). </aside> </aside> </li> <li>reStructuredText: <ul class="simple"> <li>Use the same CSV format for the :header: option and the main data of the "<a class="reference external" href="docs/ref/rst/directives.html#csv-table">csv-table</a>" directive.</li> <li>New option "loading" for the <a class="reference external" href="docs/ref/rst/directives.html#image">"image" directive</a>. Sets the new attribute <a class="reference external" href="docs/ref/doctree.html#loading">loading</a> of the <image> doctree element.</li> </ul> </li> <li>Configuration changes: <ul> <li>New configuration setting <a class="reference external" href="docs/user/config.html#root-prefix">root_prefix</a>. Configurable root directory for included files.</li> <li>New configuration setting <a class="reference external" href="docs/user/config.html#sources">sources</a> for the "buildhtml.py" application.</li> <li>Simpler and more secure <a class="reference external" href="docs/api/publisher.html#encodings">input encoding</a> default behaviour: Do not use the locale encoding as fallback if Python is started in <a class="reference external" href="https://docs.python.org/3/library/os.html#utf8-mode">UTF-8 mode</a>. Stop using "latin1" as second fallback. Remove BOM (U+FEFF ZWNBSP at start of data) only if the <a class="reference external" href="docs/user/config.html#input-encoding">input_encoding</a> configuration setting is None, '', 'utf-8-sig', 'utf-16', or 'utf-32'. Do not remove other ZWNBSPs. </li> </ul> </li> <li>Output changes: <dl> <dt>HTML5:</dt> <dd>Stop setting the "footnote-reference" class value for footnote references. Use the CSS selector [role="doc-noteref"] (works since Docutils聽0.18, see minimal.css for examples). Fix MathML rendering problems in Chrome/Chromium based browsers. Embed SVG images as <svg> instead of data-URI. </dd> <dt>manpage:</dt> <dd>Use .EE/.EX macros for literal blocks. Render URI references (do not use .UR/.UE). Use box option for tables. </dd> </dl> </li> <li>Removed objects: <dl class="simple"> <dt><cite>docutils.nodes.reprunicode</cite>, <cite>docutils.nodes.ensure_str()</cite></dt> <dd>Python聽2 compatibility hacks </dd> <dt><cite>docutils.utils.Reporter.set_conditions()</cite></dt> <dd>obsolete </dd> <dt><cite>writers.latex2e.Table.get_caption</cite></dt> <dd>obsolete </dd> </dl> </li> <li>New files: <dl class="simple"> <dt>docutils/writers/html5_polyglot/italic-field-names.css</dt> <dd>Alternative style for Docutils field-lists. </dd> </dl> </li> <li>Removed files: <dl class="simple"> <dt>install.py, setup.py</dt> <dd>Metadata is now stored in pyproject.toml, supported by <a class="reference external" href="https://pypi.org/project/pip/">pip</a> since version 19.0 (2019-01-22). See <a class="reference external" href="README.html#installation">README</a> for installation alternatives. </dd> </dl> </li> <li>Bugfixes and improvements (see <a class="reference external" href="HISTORY.html">HISTORY</a>).</li> </ul> </section> <section id="release-0-20-1-2023-05-17"> <h2><a class="toc-backref" href="#toc-entry-11" role="doc-backlink">Release 0.20.1 (2023-05-17)</a><a class="self-link" title="link to this section" href="#release-0-20-1-2023-05-17"></a></h2> Bugfix release. See <a class="reference external" href="HISTORY.html">HISTORY</a> for details. </section> <section id="release-0-20-2023-05-04"> <h2><a class="toc-backref" href="#toc-entry-12" role="doc-backlink">Release 0.20 (2023-05-04)</a><a class="self-link" title="link to this section" href="#release-0-20-2023-05-04"></a></h2> <aside class="admonition note"> Note Docutils 0.20 is the last version supporting Python聽3.7 and 3.8. </aside> <ul> <li>General <ul class="simple"> <li>Support Python聽3.11 (patch #198 by Hugo van Kemenade).</li> </ul> </li> <li>Output changes: <dl class="simple"> <dt>HTML5:</dt> <dd>Use dpub-ARIA role "doc-footnote" (instead of ARIA role "note") for footnotes. </dd> <dt>LaTeX:</dt> <dd>Do not load the <cite>inputenc</cite> package in UTF-8 encoded LaTeX sources. (UTF-8 is the default encoding for LaTeX2e since 2018). </dd> </dl> </li> <li>Configuration changes: <ul class="simple"> <li>Settings in the [latex2e writer] configuration file section are now ignored by the "xetex" writer. Place common settings in section <a class="reference external" href="docs/user/config.html#latex-writers">[latex writers]</a>.</li> <li>New configuration setting "<a class="reference external" href="docs/user/config.html#output">output</a>". Obsoletes the <destination> positional argument (cf. <a class="reference internal" href="#command-line-usage-pattern">future changes</a>). </li> </ul> </li> <li><cite>utils.find_file_in_dirs()</cite> now returns a POSIX path also on Windows; <cite>utils.get_stylesheet_list()</cite> no longer converts \ to /.</li> <li>docutils/languages/ docutils/parsers/rst/languages/ <ul class="simple"> <li>Support Ukrainian. Patch by Dmytro Kazanzhy.</li> </ul> </li> <li>test/coverage.sh <ul class="simple"> <li>Removed. Use the <a class="reference external" href="https://pypi.org/project/coverage/">coverage.py</a> project instead, coverage run test/alltests.py and coverage report.</li> </ul> </li> <li>tools/ <ul class="simple"> <li>Moved quicktest.py to tools/dev/.</li> </ul> </li> <li>Bugfixes and improvements (see <a class="reference external" href="HISTORY.html">HISTORY</a>).</li> </ul> </section> <section id="release-0-19-2022-07-05"> <h2><a class="toc-backref" href="#toc-entry-13" role="doc-backlink">Release 0.19 (2022-07-05)</a><a class="self-link" title="link to this section" href="#release-0-19-2022-07-05"></a></h2> (Release 0.19b1 (2022-06-21)) <ul> <li>Drop support for Python 2.7, 3.5, and 3.6.</li> <li>Output changes: <dl> <dt>HTML5:</dt> <dd>Wrap groups of footnotes in an <aside> for easier styling. The CSS rule .footnote-list { display: contents; } can be used to restore the behaviour of custom CSS styles. </dd> </dl> </li> <li>After package installation, the CLI commands python -m docutils and docutils start the <a class="reference external" href="docs/user/tools.html#generic-command-line-front-end">generic command line front end tool</a>.</li> <li>Support parsing "Markdown" input with 3rd party parsers <a class="reference external" href="https://pypi.org/project/myst-docutils">myst</a>, <a class="reference external" href="https://pypi.org/project/pycmark/">pycmark</a>, or <a class="reference external" href="https://pypi.org/project/recommonmark/">recommonmark</a>.</li> <li>The default values for the "pep-references", "rfc-base-url", and "python-home" <a class="reference external" href="docs/user/config.html">configuration settings</a> now use the "https:" scheme. The PEP-writer template's header is updated to fix links and resemble the header of official PEPs.</li> <li>Various bugfixes and improvements (see <a class="reference external" href="HISTORY.html">HISTORY</a>).</li> </ul> </section> <section id="release-0-18-1-2021-12-23"> <h2><a class="toc-backref" href="#toc-entry-14" role="doc-backlink">Release 0.18.1 (2021-12-23)</a><a class="self-link" title="link to this section" href="#release-0-18-1-2021-12-23"></a></h2> <aside class="admonition note"> Note Docutils 0.18.1 is the last version supporting Python聽2.7, 3.5, and 3.6. </aside> <ul class="simple"> <li>nodes.Node.traverse() returns a list again to restore backwards compatibility (fixes bug #431). Use nodes.Node.findall() to get an iterator.</li> <li>re-add module parsers.rst.directives.html (stub, emits deprecation warning and loads "Meta" directive from its new place at parsers.rst.directives.misc.)</li> <li>Small bugfixes (see <a class="reference external" href="HISTORY.html">HISTORY</a>).</li> </ul> </section> <section id="release-0-18-2021-10-26"> <h2><a class="toc-backref" href="#toc-entry-15" role="doc-backlink">Release 0.18 (2021-10-26)</a><a class="self-link" title="link to this section" href="#release-0-18-2021-10-26"></a></h2> <ul> <li>Output changes: <dl> <dt>Identifiers:</dt> <dd><ul> <li>During <a class="reference external" href="docs/ref/rst/directives.html#identifier-normalization">identifier normalization</a>, leading number and hyphen characters are no longer stripped from a <a class="reference external" href="docs/ref/rst/restructuredtext.html#reference-names">reference name</a>, if the <a class="reference external" href="docs/user/config.html#id-prefix">id_prefix</a> setting is non-empty. <dl class="simple"> <dt>Example:</dt> <dd>with --id-prefix="DU-", a section with title "34. May" now gets the identifier key DU-34-may instead of DU-may. </dd> </dl> </li> <li>The default value for the <a class="reference external" href="docs/user/config.html#auto-id-prefix">auto_id_prefix</a> setting changed to %: "use the tag name as prefix for auto-generated IDs". Set <a class="reference external" href="docs/user/config.html#auto-id-prefix">auto_id_prefix</a> to id for unchanged auto-IDs.</li> </ul> </dd> <dt>HTML5:</dt> <dd><ul> <li>Use the semantic tag <aside> for footnote text and citations, topics (except abstract and toc), admonitions, and system messages. Use <nav> for the Table of Contents.</li> <li>Make "auto" table column widths the default: Only specify column widths, if the <a class="reference external" href="__docs/ref/rst/directives.html#table">"widths" option</a> is set and not "auto". The <a class="reference external" href="docs/user/config.html#table-style">table-style</a> setting "colwidths-grid" restores the current default. </li> <li>Items of a definition list with class argument "details" are converted to <a class="reference external" href="https://www.w3.org/TR/html52/interactive-elements.html#the-details-element">details disclosure elements</a>. Example: <pre class="literal-block">..class:: details Summary This additional information should be hidden.</pre> </li> <li>Do not add "compound-first", "compound-middle", or "compound-last" to elements nested in a compound. Use child selector and ":first-child", ":last-child" pseudo classes instead.</li> <li>Use class value "backrefs" instead of "fn-backref" for a span of back-references.</li> <li>Write footnote brackets and field term colons to HTML, so that they are present also without CSS and when copying text.</li> <li>Move space character between section number and heading into "sectnum" span.</li> </ul> </dd> <dt><a class="reference external" href="docs/user/config.html#math-output">math-output</a>: html</dt> <dd><ul class="simple"> <li>Support more commands, fix mapping of commands to Unicode characters.</li> <li>Scale variable sized operators and big delimiters with CSS.</li> <li>Don't use <tt> element (deprecated in HTML5).</li> <li>Use STIX fonts if available.</li> </ul> </dd> <dt>LaTeX:</dt> <dd><a class="reference external" href="docs/user/config.html#legacy-class-functions">legacy_class_functions</a> setting default changed to "False", admonitions are now environments. </dd> </dl> </li> <li>New standard Docutils doctree node: <<a class="reference external" href="docs/ref/doctree.html#meta">meta</a>>. </li> <li>New configuration settings: <ul class="simple"> <li>[latex聽writers]聽<a class="reference external" href="docs/user/config.html#legacy-column-widths">legacy_column_widths</a> and</li> <li>[html5聽writer]聽<a class="reference external" href="docs/user/config.html#image-loading">image_loading</a>.</li> </ul> </li> <li>Removed files: iepngfix.htc and blank.gif (IE聽6 workaround for <cite>s5_html</cite>).</li> <li>Removed sub-module: parsers.rst.directives.html (reversed in release 0.18.1).</li> <li>Removed function: utils.unique_combinations() (obsoleted by itertools.combinations()).</li> <li>Removed attributes: <ul class="simple"> <li>HTMLTranslator.topic_classes: check node.parent.classes instead.</li> <li>nodes.Text.rawsource: we store the null-escaped text in Text nodes since 0.16 so there is no additional information in the rawsource.</li> </ul> </li> <li>Major refactoring and fixes/additions in docutils/utils/math/math2html.py and docutils/utils/math/latex2mathml.py (mathematical notation in HTML, cf. <a class="reference external" href="docs/ref/rst/mathematics.html">LaTeX syntax for mathematics</a>).</li> <li>nodes.Node.traverse() returns an iterator instead of a list (reversed in release 0.18.1).</li> <li>Various bugfixes and improvements (see <a class="reference external" href="HISTORY.html">HISTORY</a>). Fix spelling errors in documentation and docstrings. Thanks to Dimitri Papadopoulos. </li> </ul> </section> <section id="release-0-17-1-2021-04-16"> <h2><a class="toc-backref" href="#toc-entry-16" role="doc-backlink">Release 0.17.1 (2021-04-16)</a><a class="self-link" title="link to this section" href="#release-0-17-1-2021-04-16"></a></h2> <ul class="simple"> <li>Bug fixes (for details see the Docutils <a class="reference external" href="HISTORY.html">HISTORY</a>).</li> </ul> </section> <section id="release-0-17-2021-04-03"> <h2><a class="toc-backref" href="#toc-entry-17" role="doc-backlink">Release 0.17 (2021-04-03)</a><a class="self-link" title="link to this section" href="#release-0-17-2021-04-03"></a></h2> <ul class="simple"> <li>Numerous bug fixes and improvements (for details see the Docutils <a class="reference external" href="HISTORY.html">HISTORY</a>).</li> <li>Installing with setup.py now requires <a class="reference external" href="https://pypi.org/project/setuptools/">setuptools</a>. Alternatively, install with <a class="reference external" href="https://pypi.org/project/pip/">pip</a>.</li> <li>The generic command line front end tool <a class="reference external" href="docs/user/tools.html#docutils-cli-py">docutils-cli.py</a> allows the free selection of reader, parser, and writer components.</li> <li>Support Arabic language.</li> <li>New, experimental wrapper to integrate the <a class="reference external" href="https://pypi.org/project/recommonmark/">recommonmark</a> Markdown parser for use with Docutils. Currently only tested with recommonmark version 0.4.0. </li> <li>HTML5 writer: <ul> <li>New option <a class="reference external" href="docs/user/config.html#embed-images">embed_images</a>.</li> <li>Use semantic tags (for details see the Docutils <a class="reference external" href="HISTORY.html">HISTORY</a>).</li> <li>Change the <a class="reference external" href="docs/user/config.html#initial-header-level">initial_header_level</a> setting's default to "2", as browsers use the <a class="reference external" href="https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article">same style for <h1> and <h2> when nested in a section</a>.</li> <li>New optional style responsive.css, adapts to different screen sizes.</li> <li>Move non-essential styling from minimal.css to plain.css rsp. responsive.css.</li> <li>Show code line numbers as pseudo-elements so they are skipped when copying the code block from the page.</li> </ul> </li> <li>LaTeX writer: <ul> <li>New configuration setting <a class="reference external" href="docs/user/config.html#legacy-class-functions">legacy_class_functions</a>.</li> <li>The special value "auto" for the <a class="reference external" href="docs/user/config.html#graphicx-option">graphicx_option</a> setting is no longer supported (it never worked for xetex/luatex).</li> <li><a class="reference external" href="docs/user/latex.html#classes">Styling commands</a> using the legacy \docutilsrole prefix are now ignored. Use \DUrole. </li> <li>Most helper commands and element definitions are now defined in the LaTeX package <a class="reference external" href="https://ctan.org/pkg/docutils">docutils.sty</a> and only inserted in the document preamble if the <a class="reference external" href="docs/user/config.html#stylesheet-latex-writers">stylesheet</a> setting does not lists "docutils". </li> <li>Remove legacy LaTeX stylesheet docutils-05-compat.sty.</li> </ul> </li> </ul> </section> <section id="release-0-16-2020-01-12"> <h2><a class="toc-backref" href="#toc-entry-18" role="doc-backlink">Release 0.16 (2020-01-12)</a><a class="self-link" title="link to this section" href="#release-0-16-2020-01-12"></a></h2> Docutils 0.16.x supports Python 2.7 and Python >= 3.5 natively, without the use of the 2to3 tool. <ul class="simple"> <li>reStructuredText: <ul> <li>Keep <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism">backslash escapes</a> in the document tree. This allows, e.g., escaping of author-separators in <a class="reference external" href="docs/ref/rst/restructuredtext.html#bibliographic-fields">bibliographic fields</a>.</li> </ul> </li> <li>LaTeX writer: <ul> <li>Informal titles of type "rubric" default to bold-italic and left aligned.</li> <li>Deprecate \docutilsrole prefix for styling commands: use \DUrole instead.</li> <li>Fix topic subtitle.</li> <li>Add "latex writers" to the <cite>config_section_dependencies</cite>.</li> <li>Ignore classes for <cite>rubric</cite> elements (class wrapper interferes with LaTeX formatting).</li> </ul> </li> <li>tools/buildhtml.py <ul> <li>New option --html-writer allows to select "html" (default), "html4" or "html5" (deprecated in favour of the <a class="reference external" href="docs/user/config.html#writer-buildhtml-application">"writer" setting</a> in Docutils聽0.18).</li> </ul> </li> <li>docutils/io.py <ul> <li>Remove the <cite>handle_io_errors</cite> argument from io.FileInput/Output.</li> </ul> </li> <li>docutils/nodes.py <ul> <li>If <a class="reference external" href="docs/user/config.html#auto-id-prefix">auto_id_prefix</a> ends with "%", this is replaced with the tag name.</li> </ul> </li> <li>Various bugfixes and improvements (see <a class="reference external" href="HISTORY.html">HISTORY</a>).</li> </ul> </section> <section id="release-0-15-2019-07-20"> <h2><a class="toc-backref" href="#toc-entry-19" role="doc-backlink">Release 0.15 (2019-07-20)</a><a class="self-link" title="link to this section" href="#release-0-15-2019-07-20"></a></h2> Docutils 0.15.x is compatible with Python versions 2.6, 2.7 and 3.3 to 3.5. <aside class="admonition note"> Note Docutils 0.15.x is the last version supporting Python 2.6, 3.3 and 3.4. </aside> <ul class="simple"> <li>reStructuredText: <ul> <li>Allow embedded colons in field list field names (before, tokens like :this:example: were considered ordinary text).</li> <li>Fixed a bug with the "trim" options of the "unicode" directive.</li> </ul> </li> <li>languages: Added Korean localisation (ko).</li> </ul> </section> <section id="release-0-14-2017-08-03"> <h2><a class="toc-backref" href="#toc-entry-20" role="doc-backlink">Release 0.14 (2017-08-03)</a><a class="self-link" title="link to this section" href="#release-0-14-2017-08-03"></a></h2> <aside class="admonition note"> Note Docutils 0.14.x is the last version supporting Python 2.4, 2.5, 3.1, and 3.2. </aside> <ul class="simple"> <li>docutils/docs/ref/docutils.dtd: <ul> <li>Enable validation of Docutils XML documents against the DTD:</li> </ul> </li> <li>docutils/parsers/rst/: <ul> <li>Added functionality: escaped whitespace in URI contexts.</li> <li>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.)</li> </ul> </li> <li>docutils/utils/smartquotes.py: <ul> <li>Update quote definitions for et, fi, fr, ro, sv, tr, uk.</li> <li>Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.</li> <li>Differentiate apostrophe from closing single quote (if possible).</li> <li>Add command line interface for stand-alone use (requires 2.7).</li> </ul> </li> <li>docutils/writers/_html_base: <ul> <li>Provide default title in metadata.</li> <li>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 <cite>math-output</cite> is set to MathJax without specifying a URL. See <a class="reference external" href="docs/user/config.html#math-output">math-output</a> for details.</li> </ul> </li> <li>docutils/writers/html4css1: <ul> <li>Respect automatic table column sizing.</li> </ul> </li> <li>docutils/writers/latex2e/__init__.py <ul> <li>Handle class arguments for block-level elements by wrapping them in a "DUclass" environment. This replaces the special handling for "epigraph" and "topic" elements.</li> </ul> </li> <li>docutils/writers/odf_odt: <ul> <li>Language option sets ODF document's default language</li> <li>Image width, scale, ... set image size in generated ODF.</li> </ul> </li> <li>tools/ <ul> <li>New front-end rst2html4.py.</li> </ul> </li> </ul> </section> <section id="release-0-13-1-2016-12-09"> <h2><a class="toc-backref" href="#toc-entry-21" role="doc-backlink">Release 0.13.1 (2016-12-09)</a><a class="self-link" title="link to this section" href="#release-0-13-1-2016-12-09"></a></h2> <ul class="simple"> <li>docutils/writers/html5_polyglot <ul> <li>New HTML writer generating <a class="reference external" href="https://www.w3.org/TR/html5/">HTML 5</a>.</li> </ul> </li> <li>tools/ <ul> <li>New front-end rst2html5.py.</li> </ul> </li> <li>languages: persian/farsi (fa) and latvian (la) mappings.</li> <li>change default base url for :rfc: to <a class="reference external" href="http://tools.ietf.org/html/">http://tools.ietf.org/html/</a></li> <li>tables accept widths, a list and align</li> <li>latex2e: Fix admonition width, remove deprecated options, better tablewidth auto, ...</li> <li>rst.el: The problem with electric-indent-mode has been fixed.</li> </ul> </section> <section id="release-0-12-2014-07-06"> <h2><a class="toc-backref" href="#toc-entry-22" role="doc-backlink">Release 0.12 (2014-07-06)</a><a class="self-link" title="link to this section" href="#release-0-12-2014-07-06"></a></h2> Small changes only, release current state </section> <section id="release-0-11-2013-07-22"> <h2><a class="toc-backref" href="#toc-entry-23" role="doc-backlink">Release 0.11 (2013-07-22)</a><a class="self-link" title="link to this section" href="#release-0-11-2013-07-22"></a></h2> <ul> <li>General <ul class="simple"> <li>Apply [ 2714873 ] Fix for the overwriting of document attributes.</li> <li>Support embedded aliases within hyperlink references.</li> <li>Fix [ 228 ] try local import of docutils components (reader, writer, parser, language module) before global search.</li> </ul> </li> <li>docutils/parsers/rst/directives/tables.py <ul class="simple"> <li>Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.</li> </ul> </li> <li>docutils/writers/html4css1/__init__.py - Fix [ 3600051 ] for tables in a list, table cells are not compacted. - New setting <cite>stylesheet_dirs</cite> (see above). <blockquote> Now, it is easy to add a custom stylesheet to Docutils' default stylesheet with, e.g., --stylesheet_path='html4css1.css, mystyle.css' <dl class="simple"> <dt>Changed behaviour of the default settings:</dt> <dd>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. </dd> </dl> </blockquote> <ul class="simple"> <li>New default for <a class="reference external" href="docs/user/config.html#math-output">math-output</a>: HTML math.css.</li> <li>Avoid repeated class declarations in html4css1 writer (modified version of patch [ 104 ]).</li> </ul> </li> <li>docutils/writers/latex2e/__init__.py <ul class="simple"> <li>Drop the simple algorithm replacing straight double quotes with English typographic ones. Activate the <a class="reference external" href="docs/user/config.html#smart-quotes">SmartQuotes</a> transform if you want this feature.</li> <li>New setting <cite>stylesheet_dirs</cite>: Comma-separated list of directories where stylesheets are found. Used by <cite>stylesheet_path</cite> when expanding relative path arguments.</li> </ul> </li> <li>docutils/writers/manpage.py <ul class="simple"> <li>Fix [3607063] handle lines starting with a period.</li> <li>Fix option separating comma was bold (thanks to Bill Morris).</li> </ul> </li> </ul> </section> <section id="release-0-10-2012-12-16"> <h2><a class="toc-backref" href="#toc-entry-24" role="doc-backlink">Release 0.10 (2012-12-16)</a><a class="self-link" title="link to this section" href="#release-0-10-2012-12-16"></a></h2> Docutils 0.10 is compatible with Python versions from 2.4 to 3.2. <ul> <li>General: <ul> <li>SmartQuotes transform for typographic quotes and dashes.</li> <li>docutils/math, docutils/error_reporting.py, and docutils/urischemes.py moved to the utils package. Code importing these modules needs to adapt, e.g.: <pre class="literal-block">try: import docutils.math as math except ImportError: import docutils.utils.math as math</pre> </li> <li>enhanced math and error handling.</li> </ul> </li> <li>docutils/io.py <ul class="simple"> <li>FileInput/FileOutput: no system-exit on IOError. The <cite>handle_io_errors</cite> argument is ignored.</li> </ul> </li> <li>docutils/writers/html4css1/__init__.py <ul class="simple"> <li>Use <code> tag for inline "code", do not drop nested inline nodes (syntax highlight tokens).</li> <li>Customizable MathJax URL (based on patch by Dmitry Shachnev).</li> <li>No line break after opening inline math tag.</li> </ul> </li> <li>docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py <ul class="simple"> <li>Fix section numbering by LaTeX.</li> </ul> </li> <li>docutils/writers/s5_html/__init__.py <ul class="simple"> <li>Fix [ 3556388 ] Mathjax does not work with rst2s5.</li> </ul> </li> </ul> </section> <section id="release-0-9-1-2012-06-17"> <h2><a class="toc-backref" href="#toc-entry-25" role="doc-backlink">Release 0.9.1 (2012-06-17)</a><a class="self-link" title="link to this section" href="#release-0-9-1-2012-06-17"></a></h2> <aside class="admonition note"> Note Docutils 0.9.1 is the last version supporting Python 2.3. </aside> <ul> <li>General: Several fixes for Python 3 usage. </li> <li>docutils/setup.py <ul> <li>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. </li> </ul> </li> </ul> </section> <section id="release-0-9-2012-05-02"> <h2><a class="toc-backref" href="#toc-entry-26" role="doc-backlink">Release 0.9 (2012-05-02)</a><a class="self-link" title="link to this section" href="#release-0-9-2012-05-02"></a></h2> <ul> <li>General: <ul class="simple"> <li>reStructuredText "code" role and directive with syntax highlighting by <a class="reference external" href="https://pygments.org/">Pygments</a>.</li> <li>"code" option of the "include" directive.</li> </ul> <ul class="simple"> <li>Fix [ 3402314 ] allow non-ASCII whitespace, punctuation characters and "international" quotes around inline markup.</li> <li>Fix handling of missing stylesheets.</li> </ul> </li> <li>setup.py <ul class="simple"> <li>Fix [ 2971827 ] and [ 3442827 ] extras/roman.py moved to docutils/utils/roman.py</li> </ul> </li> <li>docutils/utils.py -> docutils/utils/__init__.py <ul class="simple"> <li>docutils.utils is now a package (providing a place for sub-modules)</li> </ul> </li> <li>docutils/writers/html4css1/__init__.py <ul class="simple"> <li>change default for <cite>math-output</cite> setting to MathJax</li> </ul> </li> <li>docutils/writers/latex2e/__init__.py <ul class="simple"> <li>Support the <cite>abbreviation</cite> and <cite>acronym</cite> standard roles.</li> <li>Record only files required to generate the LaTeX source as dependencies.</li> <li>Use \setcounter{secnumdepth}{0} instead of *-versions when suppressing LaTeX section numbering.</li> </ul> </li> </ul> </section> <section id="release-0-8-1-2011-08-30"> <h2><a class="toc-backref" href="#toc-entry-27" role="doc-backlink">Release 0.8.1 (2011-08-30)</a><a class="self-link" title="link to this section" href="#release-0-8-1-2011-08-30"></a></h2> <ul class="simple"> <li>General: <ul> <li>Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause) and [ 3395920 ] (correct copyright info for rst.el).</li> </ul> </li> <li>docutils/writers/latex2e/__init__.py <ul> <li>Clean up Babel language setting. Restores Sphinx compatibility.</li> </ul> </li> </ul> </section> <section id="release-0-8-2011-07-07"> <h2><a class="toc-backref" href="#toc-entry-28" role="doc-backlink">Release 0.8 (2011-07-07)</a><a class="self-link" title="link to this section" href="#release-0-8-2011-07-07"></a></h2> <ul> <li>COPYING: <ul class="simple"> <li>Some additions to the Docutils core are released under the 2-Clause BSD license.</li> </ul> </li> <li>General: <ul class="simple"> <li>Handle language codes according to <a class="reference external" href="https://www.rfc-editor.org/rfc/bcp/bcp47.txt">BCP 47</a>.</li> <li>If the specified language is not supported by Docutils, warn and fall back to English.</li> <li>Math support: reStructuredText "math" role and directive, math and math_block doctree elements.</li> <li>Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.</li> </ul> </li> <li>reStructuredText: <ul> <li>most directives now support a "name" option that attaches a reference name. So you can write <pre class="literal-block">.. figure:: image.png :name: figure name</pre> as a short form of <pre class="literal-block">.. _figure name: .. figure:: image.png</pre> </li> </ul> </li> </ul> Internationalization: <ul class="simple"> <li>Added Lithuanian mappings.</li> </ul> Components: <ul> <li>HTML writer: <ul class="simple"> <li>New setting "math-output" with support for HTML, MathML, and LaTeX.</li> </ul> </li> <li>LaTeX2e writer: <ul class="simple"> <li>Convert image URI to a local file path.</li> <li>Apply [ 3148141 ] fix multicolumn support when a colspanning cell has more than one paragraph (Wolfgang Scherer).</li> </ul> </li> <li>XeTeX writer: <ul> <li>New writer generating LaTeX code for compiling with xelatex. XeTeX uses unicode and modern font technologies. </li> </ul> </li> <li>and fixes and enhancements here and there.</li> </ul> </section> <section id="release-0-7-2010-07-07"> <h2><a class="toc-backref" href="#toc-entry-29" role="doc-backlink">Release 0.7 (2010-07-07)</a><a class="self-link" title="link to this section" href="#release-0-7-2010-07-07"></a></h2> Components: <ul class="simple"> <li>HTML writer: <ul> <li>Support SVG and SWF images (thanks to Stefan Rank).</li> <li>Generate valid XHTML for centered images with targets. Use CSS classes instead of "align" tags for image alignment.</li> </ul> </li> <li>LaTeX2e writer: <ul> <li>Use the \url command for URLs (breaks long URLs instead of writing into the margin).</li> <li>Preserve runs of spaces in 'inline literals'.</li> <li>Deprecate figure_footnotes setting.</li> <li>Rename use_latex_footnotes setting to <a class="reference external" href="docs/user/config.html#docutils-footnotes">docutils_footnotes</a>.</li> <li>New latex_preamble setting.</li> <li>Use PDF standard fonts (Times/Helvetica/Courier) as default.</li> <li><cite>hyperref</cite> package called with unicode option (see the <a class="reference external" href="docs/user/latex.html#hyperlinks">hyperref config tips</a> for how to override).</li> <li>Drop the special <a class="reference external" href="docs/user/latex.html#output-encoding">output_encoding</a> default ("latin-1"). The Docutils wide default (usually "UTF-8") is used instead.</li> </ul> </li> <li>manpage writer: <ul> <li>Titles level 1, that is .SH, always uppercase.</li> <li>Apply patch from mg: literal text should be bold in man-pages.</li> </ul> </li> </ul> General: <ul class="simple"> <li>io.FileInput opens files as text files with universal newline support (mode "rU", configurable with the new optional argument "mode").</li> <li>setup.py: <ul> <li>Python 3 support: copy test/ and tools/ to the build-dir and convert Python sources with 2to3.</li> </ul> </li> </ul> </section> <section id="release-0-6-2009-10-11"> <h2><a class="toc-backref" href="#toc-entry-30" role="doc-backlink">Release 0.6 (2009-10-11)</a><a class="self-link" title="link to this section" href="#release-0-6-2009-10-11"></a></h2> Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6 and convertible to 3.1 code. <aside class="admonition note"> Note The "newlatex" writer is orphaned. The recommended way to generate PDF output is to use either the LaTeX2e writer or one of the alternatives listed at <a class="reference external" href="https://docutils.sourceforge.io/docs/user/links.html#pdf">https://docutils.sourceforge.io/docs/user/links.html#pdf</a>. </aside> <ul class="simple"> <li>reStructuredText: <ul> <li>Allow length units for all length specifications.</li> <li>Allow percent sign in "scale" argument of "figure" and "image" directives.</li> <li>Bugfix: The "figalign" argument of a figure now works as intended (aligning the figure not its contents).</li> <li>Align images with class "align-[right|center|left]" (allows setting the alignment of an image in a figure).</li> <li>Hard tabs in literal inclusions are replaced by spaces. This is configurable via the new :tab-width: option of the <a class="reference external" href="docs/ref/rst/directives.html#including-an-external-document-fragment">"include" directive</a> (a negative tab-width prevents tab expansion).</li> </ul> </li> <li>HTML writer: <ul> <li>--stylesheet and --stylesheet-path options now support a comma separated list of stylesheets.</li> </ul> </li> <li>LaTeX2e writer: <ul> <li>New defaults: - font-encoding: "T1" (formerly implicitly set by 'ae'). - use-latex-toc: true (ToC with page numbers). - use-latex-footnotes: true (no mixup with figures). - Float placement defaults to "here definitely" (configurable). - Align of image in a figure defaults to 'center'. - Use class defaults for page margins ('typearea' now optional).</li> <li>Support LaTeX packages as --stylesheet arguments.</li> <li>Use bp for lengths without unit or unit pt, do not convert px to pt.</li> <li>Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.</li> <li>Set sub- and superscript role argument as text not math.</li> <li>Support custom roles based on standard roles.</li> <li>Load packages and define macros only if required in the document.</li> <li>All Docutils specific LaTeX macros are prefixed with DU.</li> <li>Better conformance to Docutils specifications with "use_latex_toc".</li> <li>If 'sectnum_xform' is False, the 'sectnum' directive triggers section numbering by LaTeX.</li> <li>Use default font in admonitions and sidebar.</li> <li>Typeset generic topic as "quote with title".</li> <li>Use template (file and configuration option).</li> <li>Render doctest blocks as literal blocks (indented).</li> </ul> </li> <li>ODT writer: <ul> <li>moved from sandbox to Doctutils core.</li> </ul> </li> <li>manpage writer: <ul> <li>moved from sandbox to Doctutils core.</li> </ul> </li> </ul> </section> <section id="release-0-5-2008-06-25"> <h2><a class="toc-backref" href="#toc-entry-31" role="doc-backlink">Release 0.5 (2008-06-25)</a><a class="self-link" title="link to this section" href="#release-0-5-2008-06-25"></a></h2> <aside class="admonition note"> Note Docutils 0.5 is the last version supporting Python 2.2. </aside> Components: <ul class="simple"> <li>HTML writer. <ul> <li>Dropped all name attributes of a elements (id is universally supported now).</li> </ul> </li> <li>LaTeX2e writer: <ul> <li>Better bibTeX citation support.</li> <li>Add --literal-block-env</li> </ul> </li> <li>PEP writer: <ul> <li>Changed to support new python.org website structure and pep2pyramid.py.</li> </ul> </li> </ul> reStructuredText: <ul class="simple"> <li>Changed the directive API to a new object-oriented system. (Compatibility for the old, functional-style directive interface is retained.) See the updated <a class="reference external" href="docs/howto/rst-directives.html">Creating reStructuredText Directives</a> how-to. </li> <li>Allow + and : in reference names requested for citations.</li> </ul> Documentation: <ul class="simple"> <li>Added <a class="reference external" href="docs/howto/security.rst">Deploying Docutils Securely</a> </li> </ul> Internationalization: <ul class="simple"> <li>Added hebrew mappings.</li> </ul> General: <ul class="simple"> <li>Configuration files are now assumed and required to be UTF-8-encoded.</li> <li>Added docutils/writers/html4css1/template.txt.</li> <li>Enhance emacs support.</li> </ul> </section> <section id="release-0-4-2006-01-09"> <h2><a class="toc-backref" href="#toc-entry-32" role="doc-backlink">Release 0.4 (2006-01-09)</a><a class="self-link" title="link to this section" href="#release-0-4-2006-01-09"></a></h2> <aside class="admonition note"> Note Docutils聽0.4 is the last version supporting Python聽2.1. It is also the last version that will make compromises in its HTML output for Netscape Navigator聽4. Docutils聽0.5 will require more up-to-date browsers (the exact definition is to be determined). </aside> Components: <ul class="simple"> <li>Added an <a class="reference external" href="docs/user/slide-shows.html">S5/HTML writer</a> and the <a class="reference external" href="docs/user/tools.html#rst2s5">rst2s5.py</a> front end: multi-platform, multi-browser HTML slide shows. </li> <li>The newlatex2e writer is nearing completion.</li> <li>Added a DocTree reader, publish_doctree and publish_from_doctree convenience functions, for document tree extraction and reprocessing.</li> </ul> reStructuredText: <ul class="simple"> <li>Added directives: "<a class="reference external" href="docs/ref/rst/directives.html#container">container</a>" (generic block-level container), "<a class="reference external" href="docs/ref/rst/directives.html#default-role">default-role</a>" (role used for `backtick` syntax), "<a class="reference external" href="docs/ref/rst/directives.html#title">title</a>" (document title metadata), and "<a class="reference external" href="docs/ref/rst/directives.html#date">date</a>" (generate the current local date, for substitution definitions). </li> <li>Length units are now supported for <a class="reference external" href="docs/ref/rst/directives.html#image">image</a> sizes. </li> <li>Added <a class="reference external" href="docs/ref/rst/definitions.html">standard definition files</a> for special characters etc. </li> </ul> Internationalization: <ul class="simple"> <li>Added Japanese and Simplified Chinese language mappings, and support for double-width CJK-characters in tables and section titles.</li> </ul> Documentation: <ul class="simple"> <li>Added a <a class="reference external" href="docs/dev/distributing.html">guide for distributors</a> (package maintainers) and a <a class="reference external" href="docs/dev/hacking.html">guide for developers</a>. </li> </ul> General: <ul class="simple"> <li>Added significant <a class="reference external" href="docs/user/emacs.html">Emacs support for reST</a>. </li> <li>Added a <a class="reference external" href="docs/user/config.html#strip-comments">--strip-comments</a> option. </li> <li><a class="reference external" href="docs/user/config.html#embed-stylesheet">--embed-stylesheet</a> is now the default for the HTML writer (rather than --link-stylesheet). </li> </ul> </section> <section id="release-0-3-9-2005-05-26"> <h2><a class="toc-backref" href="#toc-entry-33" role="doc-backlink">Release 0.3.9 (2005-05-26)</a><a class="self-link" title="link to this section" href="#release-0-3-9-2005-05-26"></a></h2> <ul class="simple"> <li>Added "<a class="reference external" href="docs/user/config.html#file-insertion-enabled">file_insertion_enabled</a>" and "<a class="reference external" href="docs/user/config.html#raw-enabled">raw_enabled</a>" settings. </li> <li>Added <a class="reference external" href="docs/ref/rst/restructuredtext.html#enumerated-lists">auto-enumerated lists</a>. </li> <li>Added <a class="reference external" href="docs/ref/rst/directives.html#document-header-footer">"header" and "footer"</a> directives. </li> <li>Added "<a class="reference external" href="docs/ref/rst/directives.html#list-table">list-table</a>" directive. </li> <li>Added support for <a class="reference external" href="docs/user/config.html#sectsubtitle-xform">section subtitles</a>. </li> <li>Added "<a class="reference external" href="docs/user/config.html#field-name-limit">field_name_limit</a>" and "<a class="reference external" href="docs/user/config.html#option-limit">option_limit</a>" settings to HTML writer. </li> <li>Added "<a class="reference external" href="docs/user/config.html#cloak-email-addresses">cloak_email_addresses</a>" setting to HTML writer. </li> <li>UTF-8 BOMs are now removed from the input stream.</li> </ul> </section> <section id="release-0-3-7-2004-12-24"> <h2><a class="toc-backref" href="#toc-entry-34" role="doc-backlink">Release 0.3.7 (2004-12-24)</a><a class="self-link" title="link to this section" href="#release-0-3-7-2004-12-24"></a></h2> <ul class="simple"> <li>A special "<a class="reference external" href="docs/ref/rst/restructuredtext.html#line-blocks">line block</a>" syntax has been added. (Also see the <a class="reference external" href="docs/user/rst/quickref.html#line-blocks">quick reference</a>.) </li> <li>Empty sections are now allowed.</li> <li>A "<a class="reference external" href="docs/ref/rst/roles.html#raw">raw</a>" role has been added. </li> <li>The LaTeX writer now escapes consecutive dashes (like "--" or "---") so that they are no longer transformed by LaTeX to en or em dashes. (Please see the <a class="reference external" href="FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document">FAQ</a> for how to represent such dashes.) </li> <li>A <a class="reference external" href="docs/user/config.html#record-dependencies">dependency recorder</a> has been added. </li> <li>A directive has been added for <a class="reference external" href="docs/ref/rst/directives.html#compound-paragraph">compound paragraphs</a>. </li> </ul> </section> <section id="release-0-3-5-2004-07-29"> <h2><a class="toc-backref" href="#toc-entry-35" role="doc-backlink">Release 0.3.5 (2004-07-29)</a><a class="self-link" title="link to this section" href="#release-0-3-5-2004-07-29"></a></h2> <ul class="simple"> <li>Improved, extended and reorganized the <a class="reference external" href="docs/index.html">documentation</a>. </li> <li>Added "<a class="reference external" href="docs/ref/rst/directives.html#csv-table">csv-table</a>" directive. </li> </ul> </section> </main> <footer> <a class="reference external" href="RELEASE-NOTES.rst">View document source</a>. Generated on: 2024-11-14 16:17 UTC. Generated by <a class="reference external" href="https://docutils.sourceforge.io/">Docutils</a> from <a class="reference external" href="https://docutils.sourceforge.io/rst.html">reStructuredText</a> source. </footer> </body> </html>