Skip to content

Migrate documentation to MyST#680

Open
schmoelder wants to merge 2 commits into
masterfrom
doc/migrate-to-myst
Open

Migrate documentation to MyST#680
schmoelder wants to merge 2 commits into
masterfrom
doc/migrate-to-myst

Conversation

@schmoelder

Copy link
Copy Markdown
Contributor

This PR is part of a larger reorganization and unification of the documentation (see #4) and migrates the documentation from Sphinx / RST files to Myst, a modern Markdown based tool for technical and scientific publication.

As discussed in the Focus Meeting, Myst does not currently support multiple versions out of the box, which is problematic given the ongoing breaking changes. The temporary solution is to migrate to ReadTheDocs, which supports this feature, and redirect from cadet.github.io.

To-dos

  • Formatting
  • Bibliography

@codecov

codecov Bot commented Apr 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

@jbreue16

Copy link
Copy Markdown
Contributor

The best temporary solution to the multiversion probelm that would allow merging this quickly is in my opinion: keep the current GitHub.io website as is and only add a redirect to readTheDocs for the master version, i.e. add the redirect to the banner where it says "master version" and to the master branch on the sidebar. That should be possible to implement, what do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants