Convert project docs from mkdocs to myst-sphinx - #7130
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-buildandpixi run docs-serve, which are the same commands as before this PR. The pins in.pixi.tomlfor 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
mainas that is when github pages is updated.Once this is confirmed to work on
mainI will forward port to theemscripten-6xbranch.