Skip to content

docs: start of updating docs to use MyST #1391

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.

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pfackeldey
Copy link
Collaborator

This PR updates the docs to:

  • use MyST markdown instead of restructured text (except for API ref; they're a bit fragile right now so I kept them as they are)
  • use a modern theme (pydata)
  • reduce ~200 bugs/typos from existing doc strings
  • add a User Guide section that can be filled with more 'hands-on' docs

@pfackeldey
Copy link
Collaborator Author

The CI doesn't seem to pickup the Makefile from the PR to build the docs... :/

@pfackeldey pfackeldey mentioned this pull request Aug 7, 2025
7 tasks
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