Changelog
### 5.1.1
```
=====================================
Bugs fixed
----------
* 10701: Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean``
iterator implementation.
* 10702: Restore compatability with third-party builders.
```
### 5.1.0
```
=====================================
Dependencies
------------
* 10656: Support `Docutils 0.19`_. Patch by Adam Turner.
.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05
Deprecated
----------
* 10467: Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``.
Patch by Adam Turner.
* 9856: Deprecated ``sphinx.ext.napoleon.iterators``.
Features added
--------------
* 10444: html theme: Allow specifying multiple CSS files through the ``stylesheet``
setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings.
* 10366: std domain: Add support for emphasising placeholders in :rst:dir:`option`
directives through a new :confval:`option_emphasise_placeholders` configuration
option.
* 10439: std domain: Use the repr of some variables when displaying warnings,
making whitespace issues easier to identify.
* 10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by
Pradyun Gedam.
* 10648: LaTeX: CSS-named-alike additional :ref:`'sphinxsetup' <latexsphinxsetup>`
keys allow to configure four separate border-widths, four paddings, four
corner radii, a shadow (possibly inset), colours for border, background, shadow
for each of the code-block, topic, attention, caution, danger, error and warning
directives.
* 10655: LaTeX: Explain non-standard encoding in LatinRules.xdy
* 10599: HTML Theme: Wrap consecutive footnotes in an ``<aside>`` element when
using Docutils 0.18 or later, to allow for easier styling. This matches the
behaviour introduced in Docutils 0.19. Patch by Adam Turner.
* 10518: config: Add ``include_patterns`` as the opposite of ``exclude_patterns``.
Patch by Adam Turner.
Bugs fixed
----------
* 10594: HTML Theme: field term colons are doubled if using Docutils 0.18+
* 10596: Build failure if Docutils version is 0.18 (not 0.18.1) due
to missing ``Node.findall()``
* 10506: LaTeX: build error if highlighting inline code role in figure caption
(refs: 10251)
* 10634: Make -P (pdb) option work better with exceptions triggered from events
* 10031: py domain: Fix spurious whitespace in unparsing various operators (``+``,
``-``, ``~``, and ``**``). Patch by Adam Turner.
* 10460: logging: Always show node source locations as absolute paths.
* HTML Search: HTML tags are displayed as a part of object name
* HTML Search: search snipets should not be folded
* HTML Search: Minor errors are emitted on fetching search snipets
* HTML Search: The markers for header links are shown in the search result
* 10520: HTML Theme: Fix use of sidebar classes in ``agogo.css_t``.
* 6679: HTML Theme: Fix inclusion of hidden toctrees in the agogo theme.
* 10566: HTML Theme: Fix enable_search_shortcuts does not work
* 8686: LaTeX: Text can fall out of code-block at end of page and leave artifact
on next page
* 10633: LaTeX: user injected ``\color`` commands in topic or admonition boxes may
cause color leaks in PDF due to upstream `framed.sty <https://ctan.org/pkg/framed>`_
bug
* 10638: LaTeX: framed coloured boxes in highlighted code (e.g. highlighted
diffs using Pygments style ``'manni'``) inherit thickness of code-block frame
* 10647: LaTeX: Only one ``\label`` is generated for ``desc_signature`` node
even if it has multiple node IDs
* 10579: i18n: UnboundLocalError is raised on translating raw directive
* 9577, 10088: py domain: Fix warning for duplicate Python references when
using ``:any:`` and autodoc.
* 10548: HTML Search: fix minor summary issues.
```
### 5.0.2
```
=====================================
Features added
--------------
* 10523: HTML Theme: Expose the Docutils's version info tuple as a template
variable, ``docutils_version_info``. Patch by Adam Turner.
Bugs fixed
----------
* 10538: autodoc: Inherited class attribute having docstring is documented even
if :confval:`autodoc_inherit_docstring` is disabled
* 10509: autosummary: autosummary fails with a shared library
* 10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.
* 10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+.
Patch by Adam Turner.
* 10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.
```
### 5.0.1
```
=====================================
Bugs fixed
----------
* 10498: gettext: TypeError is raised when sorting warning messages if a node
has no line number. Patch by Adam Turner.
* 10493: HTML Theme: :rst:dir:`topic` directive is rendered incorrectly with
Docutils 0.18. Patch by Adam Turner.
* 10495: IndexError is raised for a :rst:role:`kbd` role having a separator.
Patch by Adam Turner.
```
### 5.0.0
```
* 9575: autodoc: The annotation of return value should not be shown when
``autodoc_typehints="description"``
* 9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when
``autodoc_typehints="description"``
* 8180: autodoc: Docstring metadata ignored for attributes
* 10443: epub: EPUB builder can't detect the mimetype of .webp file
* 10104: gettext: Duplicated locations are shown if 3rd party extension does
not provide correct information
* 10456: py domain: ``:meta:`` fields are displayed if docstring contains two
or more meta-field
* 9096: sphinx-build: the value of progress bar for paralle build is wrong
* 10110: sphinx-build: exit code is not changed when error is raised on
builder-finished event
```
Links
- PyPI: https://pypi.org/project/sphinx
- Changelog: https://pyup.io/changelogs/sphinx/
- Homepage: https://www.sphinx-doc.org/
Changelog
### 0.18.0
```
Full Changelog: [v0.17.2...v0.18.0](https://github.com/executablebooks/MyST-Parser/compare/v0.17.2...v0.18.0)
This release adds support for Sphinx v5 (dropping v3), restructures the code base into modules, and also restructures the documentation, to make it easier for developers/users to follow.
It also introduces **document-level configuration** *via* the Markdown top-matter, under the `myst` key.
See the [Local configuration](docs/configuration.md) section for more information.
Breaking changes
This should not be breaking, for general users of the sphinx extension (with `sphinx>3`),
but will be for anyone directly using the Python API, mainly just requiring changes in import module paths.
The `to_docutils`, `to_html`, `to_tokens` (from `myst_parser/main.py`) and `mock_sphinx_env`/`parse` (from `myst_parser.sphinx_renderer.py`) functions have been removed, since these were primarily for internal testing.
Instead, for single page builds, users should use the docutils parser API/CLI (see [](docs/docutils.md)),
and for testing, functionality has been moved to <https://github.com/chrisjsewell/sphinx-pytest>.
The top-level `html_meta` and `substitutions` top-matter keys have also been deprecated (i.e. they will still work but will emit a warning), as they now form part of the `myst` config, e.g.
yaml
---
html_meta:
"description lang=en": "metadata description"
substitutions:
key1: I'm a **substitution**
---
is replaced by:
yaml
---
myst:
html_meta:
"description lang=en": "metadata description"
substitutions:
key1: I'm a **substitution**
---
Key PRs
- ♻️📚 Restructure code base and documentation (566)
- ⬆️ Drop Sphinx 3 and add Sphinx 5 support (579)
- 🐛 FIX: `parse_directive_text` when body followed by options (580)
- 🐛 FIX: floor table column widths to integers (568), thanks to Jean-Abou-Samra!
```
Links
- PyPI: https://pypi.org/project/myst-parser
- Changelog: https://pyup.io/changelogs/myst-parser/
Changelog
### 2022.06.04.1
```
- Fix the URL used in the "Edit this page" for Read the Docs builds.
```
### 2022.06.04
```
- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to `basic-ng` as the base theme (from {pypi}`sphinx-basic-ng`).
- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using `basic-ng`'s `edit-this-page` component.
- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
```
Links
- PyPI: https://pypi.org/project/furo
- Changelog: https://pyup.io/changelogs/furo/
Changelog
### 7.1.3
```
=========================
Bug Fixes
---------
- `10060 <https://github.com/pytest-dev/pytest/issues/10060>`_: When running with ``--pdb``, ``TestCase.tearDown`` is no longer called for tests when the *class* has been skipped via ``unittest.skip`` or ``pytest.mark.skip``.
- `10190 <https://github.com/pytest-dev/pytest/issues/10190>`_: Invalid XML characters in setup or teardown error messages are now properly escaped for JUnit XML reports.
- `10230 <https://github.com/pytest-dev/pytest/issues/10230>`_: Ignore ``.py`` files created by ``pyproject.toml``-based editable builds introduced in `pip 21.3 <https://pip.pypa.io/en/stable/news/#v21-3>`__.
- `3396 <https://github.com/pytest-dev/pytest/issues/3396>`_: Doctests now respect the ``--import-mode`` flag.
- `9514 <https://github.com/pytest-dev/pytest/issues/9514>`_: Type-annotate ``FixtureRequest.param`` as ``Any`` as a stop gap measure until :issue:`8073` is fixed.
- `9791 <https://github.com/pytest-dev/pytest/issues/9791>`_: Fixed a path handling code in ``rewrite.py`` that seems to work fine, but was incorrect and fails in some systems.
- `9917 <https://github.com/pytest-dev/pytest/issues/9917>`_: Fixed string representation for :func:`pytest.approx` when used to compare tuples.
Improved Documentation
----------------------
- `9937 <https://github.com/pytest-dev/pytest/issues/9937>`_: Explicit note that :fixture:`tmpdir` fixture is discouraged in favour of :fixture:`tmp_path`.
Trivial/Internal Changes
------------------------
- `10114 <https://github.com/pytest-dev/pytest/issues/10114>`_: Replace `atomicwrites <https://github.com/untitaker/python-atomicwrites>`__ dependency on windows with `os.replace`.
```
Links
- PyPI: https://pypi.org/project/pytest
- Changelog: https://pyup.io/changelogs/pytest/
- Homepage: https://docs.pytest.org/en/latest/
Changelog
### 0.4.5
```
* Catch a racy ValueError that could occur on exit.
* Create README-hacking.md, for Colorama contributors.
* Tweak some README unicode characters that don't render correctly on PyPI.
* Fix some tests that were failing on some operating systems.
* Add support for Python 3.9.
* Add support for PyPy3.
* Add support for pickling with the ``dill`` module.
```
Links
- PyPI: https://pypi.org/project/colorama
- Changelog: https://pyup.io/changelogs/colorama/
- Repo: https://github.com/tartley/colorama
Update Sphinx from 4.5.0 to 5.1.1.
Changelog
### 5.1.1 ``` ===================================== Bugs fixed ---------- * 10701: Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean`` iterator implementation. * 10702: Restore compatability with third-party builders. ``` ### 5.1.0 ``` ===================================== Dependencies ------------ * 10656: Support `Docutils 0.19`_. Patch by Adam Turner. .. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05 Deprecated ---------- * 10467: Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``. Patch by Adam Turner. * 9856: Deprecated ``sphinx.ext.napoleon.iterators``. Features added -------------- * 10444: html theme: Allow specifying multiple CSS files through the ``stylesheet`` setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings. * 10366: std domain: Add support for emphasising placeholders in :rst:dir:`option` directives through a new :confval:`option_emphasise_placeholders` configuration option. * 10439: std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify. * 10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by Pradyun Gedam. * 10648: LaTeX: CSS-named-alike additional :ref:`'sphinxsetup' <latexsphinxsetup>` keys allow to configure four separate border-widths, four paddings, four corner radii, a shadow (possibly inset), colours for border, background, shadow for each of the code-block, topic, attention, caution, danger, error and warning directives. * 10655: LaTeX: Explain non-standard encoding in LatinRules.xdy * 10599: HTML Theme: Wrap consecutive footnotes in an ``<aside>`` element when using Docutils 0.18 or later, to allow for easier styling. This matches the behaviour introduced in Docutils 0.19. Patch by Adam Turner. * 10518: config: Add ``include_patterns`` as the opposite of ``exclude_patterns``. Patch by Adam Turner. Bugs fixed ---------- * 10594: HTML Theme: field term colons are doubled if using Docutils 0.18+ * 10596: Build failure if Docutils version is 0.18 (not 0.18.1) due to missing ``Node.findall()`` * 10506: LaTeX: build error if highlighting inline code role in figure caption (refs: 10251) * 10634: Make -P (pdb) option work better with exceptions triggered from events * 10031: py domain: Fix spurious whitespace in unparsing various operators (``+``, ``-``, ``~``, and ``**``). Patch by Adam Turner. * 10460: logging: Always show node source locations as absolute paths. * HTML Search: HTML tags are displayed as a part of object name * HTML Search: search snipets should not be folded * HTML Search: Minor errors are emitted on fetching search snipets * HTML Search: The markers for header links are shown in the search result * 10520: HTML Theme: Fix use of sidebar classes in ``agogo.css_t``. * 6679: HTML Theme: Fix inclusion of hidden toctrees in the agogo theme. * 10566: HTML Theme: Fix enable_search_shortcuts does not work * 8686: LaTeX: Text can fall out of code-block at end of page and leave artifact on next page * 10633: LaTeX: user injected ``\color`` commands in topic or admonition boxes may cause color leaks in PDF due to upstream `framed.sty <https://ctan.org/pkg/framed>`_ bug * 10638: LaTeX: framed coloured boxes in highlighted code (e.g. highlighted diffs using Pygments style ``'manni'``) inherit thickness of code-block frame * 10647: LaTeX: Only one ``\label`` is generated for ``desc_signature`` node even if it has multiple node IDs * 10579: i18n: UnboundLocalError is raised on translating raw directive * 9577, 10088: py domain: Fix warning for duplicate Python references when using ``:any:`` and autodoc. * 10548: HTML Search: fix minor summary issues. ``` ### 5.0.2 ``` ===================================== Features added -------------- * 10523: HTML Theme: Expose the Docutils's version info tuple as a template variable, ``docutils_version_info``. Patch by Adam Turner. Bugs fixed ---------- * 10538: autodoc: Inherited class attribute having docstring is documented even if :confval:`autodoc_inherit_docstring` is disabled * 10509: autosummary: autosummary fails with a shared library * 10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner. * 10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+. Patch by Adam Turner. * 10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner. ``` ### 5.0.1 ``` ===================================== Bugs fixed ---------- * 10498: gettext: TypeError is raised when sorting warning messages if a node has no line number. Patch by Adam Turner. * 10493: HTML Theme: :rst:dir:`topic` directive is rendered incorrectly with Docutils 0.18. Patch by Adam Turner. * 10495: IndexError is raised for a :rst:role:`kbd` role having a separator. Patch by Adam Turner. ``` ### 5.0.0 ``` * 9575: autodoc: The annotation of return value should not be shown when ``autodoc_typehints="description"`` * 9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when ``autodoc_typehints="description"`` * 8180: autodoc: Docstring metadata ignored for attributes * 10443: epub: EPUB builder can't detect the mimetype of .webp file * 10104: gettext: Duplicated locations are shown if 3rd party extension does not provide correct information * 10456: py domain: ``:meta:`` fields are displayed if docstring contains two or more meta-field * 9096: sphinx-build: the value of progress bar for paralle build is wrong * 10110: sphinx-build: exit code is not changed when error is raised on builder-finished event ```Links
- PyPI: https://pypi.org/project/sphinx - Changelog: https://pyup.io/changelogs/sphinx/ - Homepage: https://www.sphinx-doc.org/Update myst-parser from 0.17.2 to 0.18.0.
Changelog
### 0.18.0 ``` Full Changelog: [v0.17.2...v0.18.0](https://github.com/executablebooks/MyST-Parser/compare/v0.17.2...v0.18.0) This release adds support for Sphinx v5 (dropping v3), restructures the code base into modules, and also restructures the documentation, to make it easier for developers/users to follow. It also introduces **document-level configuration** *via* the Markdown top-matter, under the `myst` key. See the [Local configuration](docs/configuration.md) section for more information. Breaking changes This should not be breaking, for general users of the sphinx extension (with `sphinx>3`), but will be for anyone directly using the Python API, mainly just requiring changes in import module paths. The `to_docutils`, `to_html`, `to_tokens` (from `myst_parser/main.py`) and `mock_sphinx_env`/`parse` (from `myst_parser.sphinx_renderer.py`) functions have been removed, since these were primarily for internal testing. Instead, for single page builds, users should use the docutils parser API/CLI (see [](docs/docutils.md)), and for testing, functionality has been moved to <https://github.com/chrisjsewell/sphinx-pytest>. The top-level `html_meta` and `substitutions` top-matter keys have also been deprecated (i.e. they will still work but will emit a warning), as they now form part of the `myst` config, e.g. yaml --- html_meta: "description lang=en": "metadata description" substitutions: key1: I'm a **substitution** --- is replaced by: yaml --- myst: html_meta: "description lang=en": "metadata description" substitutions: key1: I'm a **substitution** --- Key PRs - ♻️📚 Restructure code base and documentation (566) - ⬆️ Drop Sphinx 3 and add Sphinx 5 support (579) - 🐛 FIX: `parse_directive_text` when body followed by options (580) - 🐛 FIX: floor table column widths to integers (568), thanks to Jean-Abou-Samra! ```Links
- PyPI: https://pypi.org/project/myst-parser - Changelog: https://pyup.io/changelogs/myst-parser/Update furo from 2022.4.7 to 2022.6.21.
Changelog
### 2022.06.04.1 ``` - Fix the URL used in the "Edit this page" for Read the Docs builds. ``` ### 2022.06.04 ``` - ✨ Advertise Sphinx 5 compatibility. - ✨ Change to `basic-ng` as the base theme (from {pypi}`sphinx-basic-ng`). - Document site-wide announcement banners. - Drop the pin on pygments. - Improve edit button, using `basic-ng`'s `edit-this-page` component. - Tweak headings to better match what users expect. - Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup). - When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo. ```Links
- PyPI: https://pypi.org/project/furo - Changelog: https://pyup.io/changelogs/furo/Update pylint from 2.13.9 to 2.15.0.
The bot wasn't able to find a changelog for this release. Got an idea?
Links
- PyPI: https://pypi.org/project/pylint - Changelog: https://pyup.io/changelogs/pylint/Update mypy from 0.960 to 0.971.
The bot wasn't able to find a changelog for this release. Got an idea?
Links
- PyPI: https://pypi.org/project/mypy - Homepage: http://www.mypy-lang.org/Update types-python-dateutil from 2.8.17 to 2.8.19.
The bot wasn't able to find a changelog for this release. Got an idea?
Links
- PyPI: https://pypi.org/project/types-python-dateutil - Repo: https://github.com/python/typeshedUpdate typing_extensions from 4.2.0 to 4.3.0.
The bot wasn't able to find a changelog for this release. Got an idea?
Links
- PyPI: https://pypi.org/project/typing-extensionsUpdate pytest from 7.1.2 to 7.1.3.
Changelog
### 7.1.3 ``` ========================= Bug Fixes --------- - `10060 <https://github.com/pytest-dev/pytest/issues/10060>`_: When running with ``--pdb``, ``TestCase.tearDown`` is no longer called for tests when the *class* has been skipped via ``unittest.skip`` or ``pytest.mark.skip``. - `10190 <https://github.com/pytest-dev/pytest/issues/10190>`_: Invalid XML characters in setup or teardown error messages are now properly escaped for JUnit XML reports. - `10230 <https://github.com/pytest-dev/pytest/issues/10230>`_: Ignore ``.py`` files created by ``pyproject.toml``-based editable builds introduced in `pip 21.3 <https://pip.pypa.io/en/stable/news/#v21-3>`__. - `3396 <https://github.com/pytest-dev/pytest/issues/3396>`_: Doctests now respect the ``--import-mode`` flag. - `9514 <https://github.com/pytest-dev/pytest/issues/9514>`_: Type-annotate ``FixtureRequest.param`` as ``Any`` as a stop gap measure until :issue:`8073` is fixed. - `9791 <https://github.com/pytest-dev/pytest/issues/9791>`_: Fixed a path handling code in ``rewrite.py`` that seems to work fine, but was incorrect and fails in some systems. - `9917 <https://github.com/pytest-dev/pytest/issues/9917>`_: Fixed string representation for :func:`pytest.approx` when used to compare tuples. Improved Documentation ---------------------- - `9937 <https://github.com/pytest-dev/pytest/issues/9937>`_: Explicit note that :fixture:`tmpdir` fixture is discouraged in favour of :fixture:`tmp_path`. Trivial/Internal Changes ------------------------ - `10114 <https://github.com/pytest-dev/pytest/issues/10114>`_: Replace `atomicwrites <https://github.com/untitaker/python-atomicwrites>`__ dependency on windows with `os.replace`. ```Links
- PyPI: https://pypi.org/project/pytest - Changelog: https://pyup.io/changelogs/pytest/ - Homepage: https://docs.pytest.org/en/latest/Update WsgiDAV from 4.0.1 to 4.0.2.
Changelog
### 4.0.2 ``` - 246 Add dir_browser/htdocs folder to sdist (.tar.gz) - 248 Provider does not support set_last_modified" error - 251 Fix removing locks in recursive mode - 255 Fix ERROR: Invalid requirement: 'cheroot~=8' - 260 Fix Case-Sensitivity issue on MOVE/COPY actions through Windows DAV - Add shelve support to MSI installer (persistent lock- and property storage) ```Links
- PyPI: https://pypi.org/project/wsgidav - Changelog: https://pyup.io/changelogs/wsgidav/ - Repo: https://github.com/mar10/wsgidavUpdate colorama from 0.4.4 to 0.4.5.
Changelog
### 0.4.5 ``` * Catch a racy ValueError that could occur on exit. * Create README-hacking.md, for Colorama contributors. * Tweak some README unicode characters that don't render correctly on PyPI. * Fix some tests that were failing on some operating systems. * Add support for Python 3.9. * Add support for PyPy3. * Add support for pickling with the ``dill`` module. ```Links
- PyPI: https://pypi.org/project/colorama - Changelog: https://pyup.io/changelogs/colorama/ - Repo: https://github.com/tartley/colorama