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.21.1 #494

Closed
wants to merge 1 commit into from

Conversation

pyup-bot
Copy link
Collaborator

This PR updates docutils from 0.18.1 to 0.21.1.

Changelog

0.21.1

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

The sdist in 0.21 was incomplete

- pypi allows no file replacing
- adding a postrelease suffix "post1": docutils-0.21.post1.tar.gz
works on pypi, but fails with pip because the metadata differs.

But if the metadata is 0.21.post1 pypi makes it a new release.

0.21.1 is the same code except for the version number.

0.21

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

* General:

- Drop support for Python 3.7 and 3.8.

- Provide ``rst2*`` "console_scripts" `entry points`_
 (without the ``.py`` extension) instead of installing the
 ``rst2*.py`` `front end tools`_ in the binary PATH. []_

 Exceptions: ``rstpep2html.py`` and ``rst2odt_prepstyles.py``:

 - Use ``docutils --reader=pep --writer=pep_html`` for a PEP preview. []_
 - Use ``python -m docutils.writers.odf_odt.prepstyles``
   to `strip the page size`__ from an ODT writer stylesheet.

 __ docs/user/odt.htmlpage-size

.. [] Some Linux distributions already use the short names.
.. [] The final rendering is done by a Sphinx-based build system
      (cf. :PEP:`676`).

* reStructuredText:

- Use the same CSV format for the ``:header:`` option and the main data
 of the "csv-table_" directive.

- New option "loading" for the `"image" directive`_.
 Sets the new attribute loading__ of the <image> doctree element.

__ docs/ref/doctree.htmlloading

* Configuration changes:

- New configuration setting root_prefix_.
 Configurable root directory for included files.

- New configuration setting sources_ for the "buildhtml.py" application.

- Simpler and more secure `input encoding`_ default behaviour:

 Do not use the locale encoding as fallback if Python is started in
 `UTF-8 mode`_. Stop using "latin1" as second fallback.

 Remove BOM (U+FEFF ZWNBSP at start of data) only if the `input_encoding`_
 configuration setting is None, '', 'utf-8-sig', 'utf-16', or 'utf-32'.
 Do not remove other ZWNBSPs.

* Output changes:

HTML5:
 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.

manpage:
 Use .EE/.EX macros for literal blocks.

 Render URI references (do not use .UR/.UE).

 Use box option for tables.

* Removed objects:

`docutils.nodes.reprunicode`, `docutils.nodes.ensure_str()`
 Python 2 compatibility hacks
`docutils.utils.Reporter.set_conditions()`
 obsolete
`docutils.core.Publisher.setup_option_parser()`
 internal, obsolete

* New files:

``docutils/writers/html5_polyglot/italic-field-names.css``
 Alternative style for Docutils field-lists.

* Removed files:

``install.py``, ``setup.py``
 Metadata is now stored in ``pyproject.toml``,
 supported by pip_ since version 19.0 (2019-01-22).
 See README__ for installation alternatives.

__ README.htmlinstallation

* Bugfixes and improvements (see HISTORY_).

.. _input encoding: docs/api/publisher.htmlencodings
.. _csv-table: docs/ref/rst/directives.htmlcsv-table
.. _"image" directive: docs/ref/rst/directives.htmlimage
.. _root_prefix: docs/user/config.htmlroot-prefix
.. _sources: docs/user/config.htmlsources

0.20.1

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

Bugfix release. See HISTORY_ for details.

0.20

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

.. Note::

Docutils 0.20 is the last version supporting Python 3.7 and 3.8.

* General

- Support Python 3.11 (patch 198 by Hugo van Kemenade).

* Output changes:

HTML5:
 Use dpub-ARIA role "doc-footnote" (instead of ARIA role "note")
 for footnotes.

LaTeX:
 Do not load the `inputenc` package in UTF-8 encoded LaTeX sources.
 (UTF-8 is the default encoding for LaTeX2e since 2018).

* Configuration changes:

- Settings in the [latex2e writer] configuration file section
 are now ignored by the "xetex" writer.
 Place common settings in section `[latex writers]`_.

- New command line setting output_. Obsoletes the ``<destination>``
 positional argument (cf. `future changes`__).

 __ `command-line usage pattern`_

* `utils.find_file_in_dirs()` now returns a POSIX path also on Windows;
`utils.get_stylesheet_list()` no longer converts ``\`` to ``/``.

* docutils/languages/
docutils/parsers/rst/languages/

- Support Ukrainian. Patch by Dmytro Kazanzhy.

* test/coverage.sh

- Removed. Use the coverage.py_ project instead,
 ``coverage run test/alltests.py`` and ``coverage report``.

* tools/

- Moved ``quicktest.py`` to ``tools/dev/``.

* Bugfixes and improvements (see HISTORY_).

.. _[latex writers]: docs/user/config.htmllatex-writers
.. _output: docs/user/config.htmloutput
.. _coverage.py: https://pypi.org/project/coverage/

0.19

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

0.19b1

* Drop support for Python 2.7, 3.5, and 3.6.

* Output changes:

HTML5:
 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.

* After package installation, the CLI commands ``python -m docutils`` and
``docutils`` start the `generic command line front end tool`_.

* Support parsing "Markdown" input with 3rd party parsers
myst_, pycmark_, or recommonmark_.

* The default values for the "pep-references", "rfc-base-url",
and "python-home" `configuration settings`_ now use the "https:" scheme.
The PEP-writer template's header is updated to fix links and
resemble the header of official PEPs.

* Various bugfixes and improvements (see HISTORY_).

.. _generic command line front end tool:
 docs/user/tools.htmlgeneric-command-line-front-end
.. _myst: https://pypi.org/project/myst-docutils
.. _pycmark: https://pypi.org/project/pycmark/
.. _recommonmark: https://pypi.org/project/recommonmark/
.. _configuration settings: docs/user/config.html
Links

@pyup-bot pyup-bot mentioned this pull request Apr 11, 2024
@pyup-bot
Copy link
Collaborator Author

Closing this in favor of #502

@pyup-bot pyup-bot closed this Apr 23, 2024
@GregaVrbancic GregaVrbancic deleted the pyup-update-docutils-0.18.1-to-0.21.1 branch April 23, 2024 21:55
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.

None yet

1 participant