Skip to content

migrate docs from Sphinx/RST to MkDocs Material#1503

Draft
jf--- wants to merge 3 commits intocompas-dev:mainfrom
jf---:jf/mkdocs-migration
Draft

migrate docs from Sphinx/RST to MkDocs Material#1503
jf--- wants to merge 3 commits intocompas-dev:mainfrom
jf---:jf/mkdocs-migration

Conversation

@jf---
Copy link
Contributor

@jf--- jf--- commented Dec 10, 2025

Summary

  • replace Sphinx with MkDocs + Material theme
  • use mkdocstrings for API docs from NumPy docstrings
  • convert 73 RST files to Markdown
  • remove RST directives from Python docstrings
  • update CI workflow for mkdocs gh-deploy
  • update invoke tasks for mkdocs commands

Test plan

  • mkdocs serve works locally
  • mkdocs build --strict passes
  • API docs render correctly
  • all navigation links work

Loading
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.

1 participant