Skip to content

docs: myst markdown #625

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

Jump to bottom
Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: myst markdown #625

wants to merge 2 commits into from

Conversation

@PhearZero
Copy link
Contributor

@PhearZero PhearZero commented Apr 2, 2025

Proposed Changes

All changes are relative to the docs directory

  • Migrates to latest Sphinx
  • Adds MyST parser and root config.py for markdown
  • Moves the sphinx reference to cli
  • Generates ./reference.md from cli/index.rst
  • Refactors links
  • Adds sphinx-markdown-builder
  • Adds sphinx-starlight-builder (fork of @joe-p 's work)

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

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@PhearZero