Skip to content

Commit 1f2472f

Browse files
DOC: Add myst markdown support (#11167)
* DOC: myst config tmp * Add rst2myst pixi task * Update whats-new
1 parent 3bad0cb commit 1f2472f

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
"sphinx.ext.mathjax",
5555
"sphinx.ext.napoleon",
5656
"jupyter_sphinx",
57+
"myst_parser",
5758
"nbsphinx",
5859
"sphinx_autosummary_accessors",
5960
"sphinx.ext.linkcode",

doc/whats-new.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Bug Fixes
5656

5757
Documentation
5858
~~~~~~~~~~~~~
59+
- Add support for myst markdown (:pull:`11167`).
60+
By `Nick Hodgskin <https://github.com/VeckoTheGecko>`_.
5961

6062

6163
Performance

pixi.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,7 @@ sphinx-remove-toctrees = "*"
239239
sphinxext-opengraph = "*"
240240
sphinxext-rediraffe = "*"
241241
cfgrib = "*"
242+
myst-parser = "*"
242243

243244
[feature.doc.tasks]
244245
doc = { cmd = "make html", cwd = "doc", description = "Build the HTML documentation." }
@@ -331,6 +332,15 @@ depends-on = [
331332
]
332333
description = "Check all minimum version test environments match Xarray's version policy."
333334

335+
[feature.tools.dependencies]
336+
python = "3.13.*"
337+
338+
[feature.tools.pypi-dependencies]
339+
rst-to-myst = { version = "*", extras = ["sphinx"] }
340+
341+
[feature.tools.tasks]
342+
rst2myst = { cmd = "rst2myst", description = "Convert rst to myst markdown" }
343+
334344
[environments]
335345
# Testing
336346
# test-just-xarray = { features = ["test"] } # https://github.com/pydata/xarray/pull/10888/files#r2511336147
@@ -443,3 +453,4 @@ default = { features = [
443453
"dev",
444454
] }
445455
policy = { features = ["policy"], no-default-feature = true }
456+
tools = { features = ["tools"], no-default-feature = true }

0 commit comments

Comments
 (0)