Skip to content

Backport PR #1899 on branch 0.11.x (Switch tutorials to myst-nb) #1904

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
flying-sheep merged 1 commit into from
Mar 7, 2025
Merged

Backport PR #1899 on branch 0.11.x (Switch tutorials to myst-nb) #1904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
# default settings
templates_path = ["_templates"]
html_static_path = ["_static"]
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
source_suffix = {".rst": "restructuredtext", ".md": "myst-nb"}
master_doc = "index"
default_role = "literal"
exclude_patterns = [
Expand All @@ -44,7 +44,7 @@
pygments_style = "sphinx"

extensions = [
"myst_parser",
"myst_nb",
"sphinx_copybutton",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
Expand All @@ -60,15 +60,17 @@
"sphinxext.opengraph",
"scanpydoc", # needs to be before linkcode
"sphinx.ext.linkcode",
"nbsphinx",
"IPython.sphinxext.ipython_console_highlighting",
"sphinx_toolbox.more_autodoc.autoprotocol",
*(p.stem for p in _extension_dir.glob("*.py")),
]
myst_enable_extensions = [
"html_image", # So README.md can be used on github and sphinx docs
"colon_fence",
"dollarmath",
]
myst_heading_anchors = 3
nb_execution_mode = "off"

# Generate the API documentation when building
autosummary_generate = True
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/notebooks
Open in desktop
Submodule notebooks updated 5 files
+8 −2 .readthedocs.yml
+1 −0 LICENSE
+16 −0 README.rst
+6 −8 awkward-arrays.ipynb
+8 −18 getting-started.ipynb
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ doc = [
"sphinx-copybutton",
"sphinx-toolbox>=3.8.0",
"sphinxext.opengraph",
"nbsphinx",
"myst-nb",
"scanpydoc[theme,typehints] >=0.15.1",
"zarr<3",
"awkward>=2.3",
Expand Down