- Updated from version 0.18.1 to 0.19
- Update of rootfile
- Changelog
Release 0.19 (2022-07-05)
* General
- Dropped support for Python 2.7, 3.5, and 3.6. and removed compatibility
hacks from code and tests.
- Code cleanup,
check PEP 8 conformity with `flake8` (exceptions in file tox.ini).
* docutils/__main__.py
- New module. Support for ``python -m docutils``.
Also used for the ``docutils`` console script `entry point`.
* docutils/core.py:
- Let `Publisher.publish()` print info and prompt when waiting for input
from a terminal (cf. https://clig.dev/#interactivity).
- Respect "input_encoding_error_handler" setting when opening a source.
* docutils/io.py
- New function `error_string()`
obsoletes `utils.error_reporting.ErrorString`.
- Class `ErrorOutput` moved here from `utils/error_reporting`.
- Use "utf-8-sig" instead of Python's default encoding if the
"input_encoding" setting is None.
- Fix error when reading of UTF-16 encoded source without trailing newline.
* docutils/parsers/__init__.py
- Aliases "markdown" and "commonmark" point to "commonmark_wrapper".
- Alias for the "myst" parser (https://pypi.org/project/myst-docutils).
- Use absolute module names in `_parser_aliases` instead of two
import attempts. (Keeps details if the `recommonmark_wrapper.py` module
raises an ImportError.)
- Prepend parser name to ImportError if importing a parser class fails.
* docutils/parsers/commonmark_wrapper.py
- New module for parsing CommonMark input. Selects a locally installed
3rd-party parser (pycmark, myst, or recommonmark).
* docutils/parsers/recommonmark_wrapper.py
- Raise ImportError, if import of the upstream parser module fails.
If called from an `"include" directive`_,
the system-message now has source/line info.
- Adapt to and test with "recommonmark" versions 0.6.0 and 0.7.1.
.. _"include" directive: docs/ref/rst/directives.html#include
* docutils/parsers/rst/__init__.py
- Update PEP base URL (fixes bug #445),
use "https:" scheme in RFC base URL.
- Add `reporter` to `Directive` class attributes.
* docutils/parsers/rst/directives/__init__.py
- `parser_name()` keeps details if converting ImportError to ValueError.
* docutils/parsers/rst/roles.py
- Don't use mutable default values for function arguments. Fixes bug #430.
* docutils/transforms/universal.py
- Fix bug #435: invalid references in `problematic` nodes
with report_level=4.
* docutils/utils/__init__.py
- `decode_path()` returns `str` instance instead of `nodes.reprunicode`.
* docutils/utils/error_reporting.py
- Add deprecation warning.
* docutils/writers/_html_base.py
- Add "html writers" to `config_section_dependencies`. Fixes bug #443.
- Write table column widths with 3 digits precision. Fixes bug #444.
* docutils/writers/html5_polyglot/__init__.py
- Add space before "charset" meta tag closing sequence.
- Remove class value "controls" from an `image` node with video content
after converting it to a "control" attribute of the <video> tag.
- Wrap groups of footnotes in an ``<aside>`` for easier styling.
* docutils/writers/pep_html/
- Use "https:" scheme in "python_home" URL default.
- Fix links in template.txt.
* setup.py:
- New "docutils" console script `entry point`__. Fixes bug #447.
__ https://packaging.python.org/en/latest/specifications/entry-points/
* test/alltests.py
- Always encode the log file "alltests.out" using 'utf-8'.
* test/DocutilsTestSupport.py
- `exception_data()` now returns None if no exception was raised.
- `recommonmark_wrapper` only imported if upstream parser is present.
* test/test_parsers/test_rst/test_directives/test_tables.py
- Fix bug #436: Null char valid in CSV since Python 3.11.
* tools/docutils-cli.py
- Allow 3rd-party drop-in components for reader and parser, too.
- Fix help output.
- Actual code moved to docutils.__main__.py.
Tested-by: Adolf Belka <adolf.belka@ipfire.org>
Signed-off-by: Adolf Belka <adolf.belka@ipfire.org>
- Update from 0.16 to 0.18.1
- Update of rootfile
- Changelog
Release 0.18.1
.. Note::
Docutils 0.18.x is the last version supporting Python 2.7, 3.5, and 3.6.
* nodes.Node.traverse() returns a list again to restore
backwards compatibility (fixes bug #431).
* Small bugfixes (see HISTORY_).
Release 0.18 (2021-10-26)
* Output changes:
Identifiers:
During `identifier normalization`_, leading number and hyphen
characters are no longer stripped from a `reference name`_, if the
id_prefix_ setting is non-empty.
Example:
with ``--id-prefix="DU-"``, a section with title "34. May"
currently gets the identifier key ``DU-may`` and after the
change the identifier key ``DU-34-may``.
The default value for the auto_id_prefix_ setting changed to ``%``:
"use the tag name as prefix for auto-generated IDs".
Set auto_id_prefix_ to ``id`` for unchanged auto-IDs.
HTML5:
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.
Make "auto" table column widths the default: Only specify column
widths, if the `"widths" option`_ is set and not "auto".
The table-style__ setting "colwidths-grid" restores the current default.
.. _"widths" option: __ docs/ref/rst/directives.html#table
__ docs/user/config.html#table-style
Items of a definition list with class argument "details" are
converted to `details disclosure elements`_. Example::
..class:: details
Summary
This additional information should be hidden.
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.
Use class value "backrefs" instead of "fn-backref" for a span of
back-references.
Write footnote brackets and field term colons to HTML, so that they
are present also without CSS and when copying text.
Move space character between section number and heading into
"sectnum" span.
math-output: html
Support more commands, fix mapping of commands to Unicode characters.
Scale variable sized operators and big delimiters with CSS.
Don't use <tt> element (deprecated in HTML5).
Use STIX fonts if available.
LaTeX:
`legacy_class_functions`_ setting default changed to "False",
admonitions are now environments.
* New standard Docutils doctree node: <meta__>.
* New configuration settings:
[latex writers] legacy_column_widths_ and
[html5 writer] image_loading_.
* Removed files:
``iepngfix.htc`` and ``blank.gif`` (IE 6 workaround for `s5_html`).
* Removed sub-module:
``parsers.rst.directives.html``
(Meta directive moved to ``parsers.rst.directives.misc``.)
* Removed function: utils.unique_combinations()
(obsoleted by itertools.combinations()).
* Removed attribute: ``HTMLTranslator.topic_classes``
(check node.parent.classes instead).
* Major refactoring and fixes/additions in
``docutils/utils/math/math2html.py`` and
``docutils/utils/math/latex2mathml.py``
(mathematical notation in HTML, cf. `LaTeX syntax for mathematics`_).
* nodes.Node.traverse() returns an iterator instead of a list.
* Various bugfixes and improvements (see HISTORY_).
Fix spelling errors in documentation and docstrings.
Thanks to Dimitri Papadopoulos.
__ docs/ref/doctree.html#meta
.. _identifier normalization:
docs/ref/rst/directives.html#identifier-normalization
.. _id_prefix: docs/user/config.html#id-prefix
.. _auto_id_prefix: docs/user/config.html#auto-id-prefix
.. _details disclosure elements:
https://www.w3.org/TR/html52/interactive-elements.html#the-details-element
.. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
.. _legacy_column_widths: docs/user/config.html#legacy-column-widths
Release 0.17.1 (2021-04-16)
* Bug fixes (for details see the Docutils `HISTORY`_).
Release 0.17 (2021-04-03)
* Numerous bug fixes and improvements
(for details see the Docutils `HISTORY`_).
* Installing with ``setup.py`` now requires setuptools_.
Alternatively, install with pip_.
* The generic command line front end tool docutils-cli.py_ allows
the free selection of reader, parser, and writer components.
* Support Arabic language.
* New, **experimental** wrapper to integrate the `recommonmark`__
Markdown parser for use with Docutils.
Currently only tested with recommonmark version 0.4.0.
__ https://pypi.org/project/recommonmark/
* HTML5 writer:
- New option embed_images_.
- Use semantic tags (for details see the Docutils `HISTORY`_).
- Change the `initial_header_level`_ setting's default to "2", as browsers
use the `same style for <h1> and <h2> when nested in a section`__.
- New optional style ``responsive.css``, adapts to different screen
sizes.
- Move non-essential styling from ``minimal.css`` to ``plain.css``
rsp. ``responsive.css``.
- Show code line numbers as pseudo-elements so they are skipped when
copying the code block from the page.
.. _initial_header_level: docs/user/config.html#initial-header-level
__ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
.. _embed_images: docs/user/config.html#embed-images
* LaTeX writer:
- New configuration setting `legacy_class_functions`_.
- The special value "auto" for the `graphicx_option`_ setting
is no longer supported (it never worked for xetex/luatex).
- `Styling commands`__ using the legacy ``\docutilsrole`` prefix are
now ignored. Use ``\DUrole``.
__ docs/user/latex.html#classes
- Most helper commands and element definitions are now defined in the
LaTeX package `docutils.sty`_ and only inserted in the document
preamble if the stylesheet__ setting does not lists "docutils".
__ docs/user/config.html#stylesheet-latex-writers
- Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
.. _setuptools: https://pypi.org/project/setuptools/
.. _pip: https://pypi.org/project/pip/
.. _docutils-cli.py: docs/user/tools.html#docutils-cli-py
.. _legacy_class_functions: docs/user/config.html#legacy-class-functions
.. _graphicx_option: docs/user/config.html#graphicx-option
.. _docutils.sty: https://ctan.org/pkg/docutils
Signed-off-by: Adolf Belka <adolf.belka@ipfire.org>
Reviewed-by: Peter Müller <peter.mueller@ipfire.org>
