Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docutils to 0.17 #268

Closed
wants to merge 1 commit into from

Conversation

pyup-bot
Copy link
Collaborator

@pyup-bot pyup-bot commented Apr 3, 2021

This PR updates docutils from 0.13.1 to 0.17.

Changelog

0.17

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

* 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.

* New, experimental wrapper to integrate the
`recommonmark`__ Markdown parser for use with Docutils.

__ https://pypi.org/project/recommonmark/

* HTML5 writer:

- Use the new semantic tags <main>, <section>, <header>,
 <footer>, <aside>, <figure>, and <figcaption>.
 See ``minimal.css`` and ``plain.css`` for styling rule examples.

 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`__.

- Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
 <i>, <b>, <u>, <mark>, and <bdi> if a matching class value
 is found in `inline` and `literal` elements.
 Use <ins> and <del> if a matching class value
 is found in `inline`, `literal`, or `container` elements.

- New optional style ``responsive.css``, adapts to different screen
 sizes.

- New option embed_images_.

.. _initial_header_level: docs/user/config.htmlinitial-header-level
__ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
.. _embed_images: docs/user/config.htmlembed-images

* docutils/writers/html5_polyglot/

- ``minimal.css``: Move non-essential styling to ``plain.css``.
 Code line numbers as pseudo-elements which are skipped when
 copying text.
- ``plain.css``: Support numbered figures.

* 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.htmlclasses

- 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.htmlstylesheet-latex-writers

- Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.

- Fixes (thanks to) from John Thorvald Wodder II: 
 alignment of nested tables, support memoir document class,

* pseudoxml-writer got a ``--detailled`` option for pretty printing text nodes.

* odf/odt-writer improved metadata handling.

* manpage-writer fixes 380 commandline option in spinx, 126 title with spaces,
168 empty citation, 394 newline after rubric.

* Miscellaneous:

- Fixes in Arabic mappings and Korean translations.
- directives: Prevent infinte inclusion loops.
- roles: Apply patch 174 `Lowercase new role names on registration`
 by John Thorvald Wodder II.


.. _setuptools: https://pypi.org/project/setuptools/
.. _pip: https://pypi.org/project/pip/
.. _docutils-cli.py: docs/user/tools.htmldocutils-cli-py
.. _legacy_class_functions: docs/user/config.htmllegacy-class-functions
.. _graphicx_option: docs/user/config.htmlgraphicx-option
.. _docutils.sty: https://ctan.org/pkg/docutils

0.16

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

.. Note::

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

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`__.

__ http://docutils.sourceforge.net/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".

__ html: docs/user/html.htmlhtml

* docutils/io.py

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

* docutils/nodes.py

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

.. _auto_id_prefix: docs/user/config.htmlauto-id-prefix

* Various bugfixes and improvements (see HISTORY_).

0.15

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

.. Note::

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

Docutils 0.15.x is compatible with Python versions 2.6, 2.7 and 3.3 to 3.5
(cf. `Python 3 compatibility`_).

* 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).

0.14

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

* 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``.
Links

@pyup-bot pyup-bot mentioned this pull request Apr 3, 2021
@pyup-bot
Copy link
Collaborator Author

Closing this in favor of #271

@pyup-bot pyup-bot closed this Apr 17, 2021
@waynr waynr deleted the pyup-update-docutils-0.13.1-to-0.17 branch April 17, 2021 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant