Skip to content

Commit 75ef9cb

Browse files
authored
🚀 RELEASE: 0.18.0 (#581)
1 parent c17d855 commit 75ef9cb

File tree

2 files changed

+49
-1
lines changed

2 files changed

+49
-1
lines changed

CHANGELOG.md

+48
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,53 @@
11
# Changelog
22

3+
## 0.18.0 - 2022-06-07
4+
5+
Full Changelog: [v0.17.2...v0.18.0](https://github.com/executablebooks/MyST-Parser/compare/v0.17.2...v0.18.0)
6+
7+
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.
8+
9+
It also introduces **document-level configuration** *via* the Markdown top-matter, under the `myst` key.
10+
See the [Local configuration](docs/configuration.md) section for more information.
11+
12+
### Breaking changes
13+
14+
This should not be breaking, for general users of the sphinx extension (with `sphinx>3`),
15+
but will be for anyone directly using the Python API, mainly just requiring changes in import module paths.
16+
17+
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.
18+
Instead, for single page builds, users should use the docutils parser API/CLI (see [](docs/docutils.md)),
19+
and for testing, functionality has been moved to <https://github.com/chrisjsewell/sphinx-pytest>.
20+
21+
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.
22+
23+
```yaml
24+
---
25+
html_meta:
26+
"description lang=en": "metadata description"
27+
substitutions:
28+
key1: I'm a **substitution**
29+
---
30+
```
31+
32+
is replaced by:
33+
34+
```yaml
35+
---
36+
myst:
37+
html_meta:
38+
"description lang=en": "metadata description"
39+
substitutions:
40+
key1: I'm a **substitution**
41+
---
42+
```
43+
44+
### Key PRs
45+
46+
- ♻️📚 Restructure code base and documentation (#566)
47+
- ⬆️ Drop Sphinx 3 and add Sphinx 5 support (#579)
48+
- 🐛 FIX: `parse_directive_text` when body followed by options (#580)
49+
- 🐛 FIX: floor table column widths to integers (#568), thanks to @Jean-Abou-Samra!
50+
351
## 0.17.2 - 2022-04-17
452

553
Full Changelog: [v0.17.1...v0.17.2](https://github.com/executablebooks/MyST-Parser/compare/v0.17.1...v0.17.2)

myst_parser/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""An extended commonmark compliant parser, with bridges to docutils & sphinx."""
2-
__version__ = "0.17.2"
2+
__version__ = "0.18.0"
33

44

55
def setup(app):

0 commit comments

Comments
 (0)