Skip to content

Migrate from nbsphinx/jupyter-sphinx to myst_nb#11456

Open
VeckoTheGecko wants to merge 45 commits into
pydata:mainfrom
VeckoTheGecko:myst-parser-support
Open

Migrate from nbsphinx/jupyter-sphinx to myst_nb#11456
VeckoTheGecko wants to merge 45 commits into
pydata:mainfrom
VeckoTheGecko:myst-parser-support

Conversation

@VeckoTheGecko

@VeckoTheGecko VeckoTheGecko commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Description

Here we migrate from jupyter-sphinx to myst_nb.

First I found all files with jupyter-sphinx directives, used rst2md on these files, and then went through manually fixing errors using sphinx-build -W (fail on warning) so that we have no more warnings.

Still need to go through each file and make sure no regressions.

TODO:

  • Visual side-by-side checks
    • doc/get-help/faq.md
    • doc/getting-started-guide/quick-overview.md
    • doc/internals/duck-arrays-integration.md
    • doc/internals/how-to-add-new-backend.md
    • doc/internals/how-to-create-custom-index.md
    • doc/internals/internal-design.md
    • doc/internals/time-coding.md
    • doc/internals/zarr-encoding-spec.md
    • doc/user-guide/combining.md
    • doc/user-guide/complex-numbers.md
    • doc/user-guide/computation.md
    • doc/user-guide/dask.md
    • doc/user-guide/data-structures.md
    • doc/user-guide/duckarrays.md
    • doc/user-guide/groupby.md
    • doc/user-guide/hierarchical-data.md
    • doc/user-guide/indexing.md (check for the linebreaks within the table, check that the numbering works and the code blocks)
    • doc/user-guide/interpolation.md
    • doc/user-guide/io.md
    • doc/user-guide/pandas.md
    • doc/user-guide/plotting.md
    • doc/user-guide/reshaping.md
    • doc/user-guide/testing.md
    • doc/user-guide/time-series.md
    • doc/user-guide/weather-climate.md
  • Look into terminology.rst
    • is it possible to use the codeblocks run in CI here even though its nested?
    • if we can update this file, we can get rid of the jupyter-sphinx dependency
  • Check doc build time before and after
  • Update contributing guidelines

Checklist

  • towards Migrate from nbsphinx to myst, myst-nb #7924 (will close once we get rid of all rst?)
  • Tests added
  • User visible changes (including notable bug fixes) are documented in whats-new.rst
  • New functions/methods are listed in api.rst

AI Disclosure

  • This PR contains AI-generated content.
    • I have tested any AI-generated content in my PR.
    • I take responsibility for any AI-generated content in my PR. Tools: Claude - very minimal

@github-actions github-actions Bot added topic-backends topic-zarr Related to zarr storage library io labels Jul 17, 2026
@VeckoTheGecko

Copy link
Copy Markdown
Contributor Author

cc @eni-awowale

VeckoTheGecko and others added 3 commits July 18, 2026 00:00
remove-input actually removes the input instead of putting it in a dropdown
remove-output actually removes the output instead of putting it in a dropdown
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

io topic-backends topic-zarr Related to zarr storage library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant