Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

Comments

DOC: migrate from Sphinx to MkDocs#880

Draft
basnijholt wants to merge 3 commits intomainfrom
mkdocs
Draft

DOC: migrate from Sphinx to MkDocs#880
basnijholt wants to merge 3 commits intomainfrom
mkdocs

Conversation

@basnijholt
Copy link
Collaborator

  • Replace Sphinx with MkDocs using Material theme
  • Convert MyST-NB syntax to MkDocs-compatible markdown
    • Convert admonitions (:::{admonition} → !!! note)
    • Fix cross-references ({class}......)
    • Convert tilde references (~module → module)
  • Update API documentation to use MkDocstrings
  • Configure .readthedocs.yml for MkDocs
  • Update dependencies in pyproject.toml
  • Add mkdocs.yml configuration with navigation structure

basnijholt and others added 2 commits September 18, 2025 15:47
- Replace Sphinx with MkDocs using Material theme
- Convert MyST-NB syntax to MkDocs-compatible markdown
  - Convert admonitions (:::{admonition} → !!! note)
  - Fix cross-references ({class}`...` → `...`)
  - Convert tilde references (~module → `module`)
- Update API documentation to use MkDocstrings
- Configure .readthedocs.yml for MkDocs
- Update dependencies in pyproject.toml
- Add mkdocs.yml configuration with navigation structure
@codspeed-hq
Copy link

codspeed-hq bot commented Sep 18, 2025

CodSpeed Instrumentation Performance Report

Merging #880 will not alter performance

Comparing mkdocs (100dc48) with main (c867a1f)

Summary

✅ 6 untouched

@LennartGevers
Copy link
Contributor

YEEEEES! I fucking love Mkdocs.

@basnijholt basnijholt changed the title docs: migrate from Sphinx to MkDocs DOC: migrate from Sphinx to MkDocs Sep 23, 2025
@github-actions
Copy link
Contributor

✅ PR Title Formatted Correctly

The title of this PR has been updated to match the correct format. Thank you!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants