Skip to content

Commit 3105807

Browse files
chrisjsewellchrisjsewell
authored
⬆️ UPGRADE: docutils 0.19 support (#611)
This PR allows docutils 0.19 to be used with myst-parser. See: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05. Note though, it does not fix a number of `DeprecationWarning` that arise from using docutils 0.19, which will be addressed at a later date.
1 parent 363b853 commit 3105807

File tree

7 files changed

+130
-108
lines changed

7 files changed

+130
-108
lines changed

‎.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ jobs:
7070
strategy:
7171
fail-fast: false
7272
matrix:
73-
docutils-version: ["0.16", "0.17", "0.18"]
73+
docutils-version: ["0.17", "0.18", "0.19"]
7474

7575
steps:
7676
- name: Checkout source

‎myst_parser/mdit_to_docutils/base.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1391,11 +1391,16 @@ def html_meta_to_nodes(
13911391
return []
13921392

13931393
try:
1394+
# if sphinx available
13941395
from sphinx.addnodes import meta as meta_cls
13951396
except ImportError:
1396-
from docutils.parsers.rst.directives.html import MetaBody
1397+
try:
1398+
# docutils >= 0.19
1399+
meta_cls = nodes.meta # type: ignore
1400+
except AttributeError:
1401+
from docutils.parsers.rst.directives.html import MetaBody
13971402

1398-
meta_cls = MetaBody.meta # type: ignore
1403+
meta_cls = MetaBody.meta # type: ignore
13991404

14001405
output = []
14011406

‎pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ keywords = [
3434
]
3535
requires-python = ">=3.7"
3636
dependencies = [
37-
"docutils>=0.15,<0.19",
37+
"docutils>=0.15,<0.20",
3838
"jinja2", # required for substitutions, but let sphinx choose version
3939
"markdown-it-py>=1.0.0,<3.0.0",
4040
"mdit-py-plugins~=0.3.0",

‎tests/test_renderers/fixtures/docutil_roles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
.
9494
<document source="notset">
9595
<paragraph>
96-
<reference refuri="http://www.python.org/dev/peps/pep-0000">
96+
<reference refuri="https://peps.python.org/pep-0000">
9797
PEP 0
9898
.
9999

@@ -104,7 +104,7 @@
104104
.
105105
<document source="notset">
106106
<paragraph>
107-
<reference refuri="http://tools.ietf.org/html/rfc1.html">
107+
<reference refuri="https://tools.ietf.org/html/rfc1.html">
108108
RFC 1
109109
.
110110

‎tests/test_renderers/test_fixtures_docutils.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,18 @@ def _apply_transforms(self):
5050
parser=Parser(),
5151
)
5252

53-
file_params.assert_expected(doctree.pformat(), rstrip_lines=True)
53+
ptree = doctree.pformat()
54+
# docutils >=0.19 changes:
55+
ptree = ptree.replace(
56+
'refuri="http://tools.ietf.org/html/rfc1.html"',
57+
'refuri="https://tools.ietf.org/html/rfc1.html"',
58+
)
59+
ptree = ptree.replace(
60+
'refuri="http://www.python.org/dev/peps/pep-0000"',
61+
'refuri="https://peps.python.org/pep-0000"',
62+
)
63+
64+
file_params.assert_expected(ptree, rstrip_lines=True)
5465

5566

5667
@pytest.mark.param_file(FIXTURE_PATH / "docutil_directives.md")

‎tests/test_sphinx/test_sphinx_builds.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,10 @@ def test_include_from_rst(
299299
)
300300

301301

302+
@pytest.mark.skipif(
303+
__version_info__ < VersionInfo(0, 19, 0, "final", 0, True),
304+
reason="Footnote HTML changed in docutils 0.19",
305+
)
302306
@pytest.mark.sphinx(
303307
buildername="html", srcdir=os.path.join(SOURCE_DIR, "footnotes"), freshenv=True
304308
)

‎tests/test_sphinx/test_sphinx_builds/test_footnotes.sphinx5.html

Lines changed: 103 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -97,113 +97,115 @@ <h1>
9797
</div>
9898
</blockquote>
9999
<hr class="footnotes docutils"/>
100-
<aside class="footnote brackets" id="c" role="note">
101-
<span class="label">
102-
<span class="fn-bracket">
103-
[
104-
</span>
105-
<a href="#id1" role="doc-backlink">
106-
1
107-
</a>
108-
<span class="fn-bracket">
109-
]
110-
</span>
111-
</span>
112-
<p>
113-
a footnote referenced first
114-
</p>
115-
</aside>
116-
<aside class="footnote brackets" id="d" role="note">
117-
<span class="label">
118-
<span class="fn-bracket">
119-
[
120-
</span>
121-
<a href="#id2" role="doc-backlink">
122-
2
123-
</a>
124-
<span class="fn-bracket">
125-
]
126-
</span>
127-
</span>
128-
<p>
129-
a footnote referenced in a directive
130-
</p>
131-
</aside>
132-
<aside class="footnote brackets" id="a" role="note">
133-
<span class="label">
134-
<span class="fn-bracket">
135-
[
136-
</span>
137-
<a href="#id3" role="doc-backlink">
138-
3
139-
</a>
140-
<span class="fn-bracket">
141-
]
142-
</span>
143-
</span>
144-
<p>
145-
some footnote
146-
<em>
147-
text
148-
</em>
149-
</p>
150-
</aside>
151-
<aside class="footnote brackets" id="b" role="note">
152-
<span class="label">
153-
<span class="fn-bracket">
154-
[
100+
<aside class="footnote-list brackets">
101+
<aside class="footnote brackets" id="c" role="note">
102+
<span class="label">
103+
<span class="fn-bracket">
104+
[
105+
</span>
106+
<a href="#id1" role="doc-backlink">
107+
1
108+
</a>
109+
<span class="fn-bracket">
110+
]
111+
</span>
155112
</span>
156-
<a href="#id4" role="doc-backlink">
157-
4
158-
</a>
159-
<span class="fn-bracket">
160-
]
113+
<p>
114+
a footnote referenced first
115+
</p>
116+
</aside>
117+
<aside class="footnote brackets" id="d" role="note">
118+
<span class="label">
119+
<span class="fn-bracket">
120+
[
121+
</span>
122+
<a href="#id2" role="doc-backlink">
123+
2
124+
</a>
125+
<span class="fn-bracket">
126+
]
127+
</span>
161128
</span>
162-
</span>
163-
<p>
164-
a footnote before its reference
165-
</p>
166-
</aside>
167-
<aside class="footnote brackets" id="id8" role="note">
168-
<span class="label">
169-
<span class="fn-bracket">
170-
[
129+
<p>
130+
a footnote referenced in a directive
131+
</p>
132+
</aside>
133+
<aside class="footnote brackets" id="a" role="note">
134+
<span class="label">
135+
<span class="fn-bracket">
136+
[
137+
</span>
138+
<a href="#id3" role="doc-backlink">
139+
3
140+
</a>
141+
<span class="fn-bracket">
142+
]
143+
</span>
171144
</span>
172-
123
173-
<span class="fn-bracket">
174-
]
145+
<p>
146+
some footnote
147+
<em>
148+
text
149+
</em>
150+
</p>
151+
</aside>
152+
<aside class="footnote brackets" id="b" role="note">
153+
<span class="label">
154+
<span class="fn-bracket">
155+
[
156+
</span>
157+
<a href="#id4" role="doc-backlink">
158+
4
159+
</a>
160+
<span class="fn-bracket">
161+
]
162+
</span>
175163
</span>
176-
</span>
177-
<span class="backrefs">
178-
(
179-
<a href="#id5" role="doc-backlink">
180-
1
181-
</a>
182-
,
183-
<a href="#id6" role="doc-backlink">
184-
2
185-
</a>
186-
)
187-
</span>
188-
<p>
189-
multiple references footnote
190-
</p>
191-
</aside>
192-
<aside class="footnote brackets" id="e" role="note">
193-
<span class="label">
194-
<span class="fn-bracket">
195-
[
164+
<p>
165+
a footnote before its reference
166+
</p>
167+
</aside>
168+
<aside class="footnote brackets" id="id8" role="note">
169+
<span class="label">
170+
<span class="fn-bracket">
171+
[
172+
</span>
173+
123
174+
<span class="fn-bracket">
175+
]
176+
</span>
196177
</span>
197-
<a href="#id7" role="doc-backlink">
198-
5
199-
</a>
200-
<span class="fn-bracket">
201-
]
178+
<span class="backrefs">
179+
(
180+
<a href="#id5" role="doc-backlink">
181+
1
182+
</a>
183+
,
184+
<a href="#id6" role="doc-backlink">
185+
2
186+
</a>
187+
)
188+
</span>
189+
<p>
190+
multiple references footnote
191+
</p>
192+
</aside>
193+
<aside class="footnote brackets" id="e" role="note">
194+
<span class="label">
195+
<span class="fn-bracket">
196+
[
197+
</span>
198+
<a href="#id7" role="doc-backlink">
199+
5
200+
</a>
201+
<span class="fn-bracket">
202+
]
203+
</span>
202204
</span>
203-
</span>
204-
<p>
205-
footnote definition in a block element
206-
</p>
205+
<p>
206+
footnote definition in a block element
207+
</p>
208+
</aside>
207209
</aside>
208210
</section>
209211
</div>

0 commit comments

Comments
 (0)