Skip to content

Convert project docs from mkdocs to myst-sphinx - #7130

Merged
ianthomas23 merged 1 commit into
emscripten-forge:mainfrom
ianthomas23:docs-myst-sphinx
Sep 30, 2026
Merged

ianthomas23 merged 1 commit into
emscripten-forge:mainfrom
ianthomas23:docs-myst-sphinx

Conversation

@ianthomas23

Copy link
Copy Markdown
Collaborator

Convert project docs from mkdocs to myst-sphinx. This is what they look like:

emforge-docs.mp4

You can build and serve the docs locally using pixi run docs-build and pixi run docs-serve, which are the same commands as before this PR. The pins in .pixi.toml for the doc dependencies are quite tolerant, we can tighten them up later if we need to. I use myst-sphinx in many other projects so I usually discover problems quite quickly.

There is a slight change to the CI workflow that generates and uploads the docs to github pages. We can only check it works on merging this to main as that is when github pages is updated.

Once this is confirmed to work on main I will forward port to the emscripten-6x branch.

@ianthomas23 ianthomas23 added the documentation Improvements or additions to documentation label Sep 30, 2026
@ianthomas23
ianthomas23 merged commit 09b501a into emscripten-forge:main Sep 30, 2026
3 checks passed
@ianthomas23
ianthomas23 deleted the docs-myst-sphinx branch September 30, 2026 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant