Skip to content

refactor: move to mkdocs-material #69

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: main
Choose a base branch
from
Draft

Conversation

msardara
Copy link
Member

@msardara msardara commented Apr 18, 2025

Small experiment trying to move the documentation to mkdocs.

Features like automatic generation from python docstring are kept with mkdocstrings and griffe-pydantic.

⚠️ Most of the .rst files were ported to markdown with a tool, so if we decide to go with this we need double to check their content.

image

@msardara msardara force-pushed the mkdocs-experiment branch 6 times, most recently from ae2a912 to b1bdb67 Compare April 18, 2025 15:33
@msardara msardara force-pushed the mkdocs-experiment branch from b1bdb67 to e494c15 Compare April 18, 2025 15:35
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