Skip to content

DOC: Add myst markdown support #11167

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.

Sign up for GitHub

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

Merged
dcherian merged 3 commits into from
Feb 13, 2026
Merged

DOC: Add myst markdown support #11167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7368ffa
DOC: myst config
VeckoTheGecko Feb 13, 2026
c3f157c
Add rst2myst pixi task
VeckoTheGecko Feb 13, 2026
bc5baf5
Update whats-new
VeckoTheGecko Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
"jupyter_sphinx",
"myst_parser",
"nbsphinx",
"sphinx_autosummary_accessors",
"sphinx.ext.linkcode",
Expand Down
2 changes: 2 additions & 0 deletions doc/whats-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Bug Fixes

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


Performance
Expand Down
11 changes: 11 additions & 0 deletions pixi.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ sphinx-remove-toctrees = "*"
sphinxext-opengraph = "*"
sphinxext-rediraffe = "*"
cfgrib = "*"
myst-parser = "*"

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

[feature.tools.dependencies]
python = "3.13.*"

[feature.tools.pypi-dependencies]
rst-to-myst = { version = "*", extras = ["sphinx"] }

[feature.tools.tasks]
rst2myst = { cmd = "rst2myst", description = "Convert rst to myst markdown" }

[environments]
# Testing
# test-just-xarray = { features = ["test"] } # https://github.com/pydata/xarray/pull/10888/files#r2511336147
Expand Down Expand Up @@ -443,3 +453,4 @@ default = { features = [
"dev",
] }
policy = { features = ["policy"], no-default-feature = true }
tools = { features = ["tools"], no-default-feature = true }
Loading