Skip to content

chore(Docs): migrate to mkdocs - #508

Merged
ShadowApex merged 2 commits into
mainfrom
shadowapex/material-for-mkdocs
Jan 22, 2026
Merged

chore(Docs): migrate to mkdocs#508
ShadowApex merged 2 commits into
mainfrom
shadowapex/material-for-mkdocs

Conversation

@ShadowApex

@ShadowApex ShadowApex commented Jan 21, 2026

Copy link
Copy Markdown
Collaborator

This change migrates our documentation to material for mkdocs away from sphinx. It also contains a new docgen project that will automatically generate the markdown for all OGUI classes.

This PR does contain many changes, but most of them are the auto-generated class documentation.

image image image

@ShadowApex
ShadowApex force-pushed the shadowapex/material-for-mkdocs branch from 865c15d to 0a1e647 Compare January 22, 2026 04:18
@ShadowApex
ShadowApex requested a review from pastaq January 22, 2026 04:18
@ShadowApex
ShadowApex marked this pull request as ready for review January 22, 2026 04:18
@ShadowApex
ShadowApex force-pushed the shadowapex/material-for-mkdocs branch 2 times, most recently from 980b151 to 19eec57 Compare January 22, 2026 05:27

@pastaq pastaq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mobile is being weird and only showing me one file at a time. Probably a new GitHub feature or something.

I didn't review everything but as it's low stakes documentation generation I'll check the wiki after it's live and address any concerns with a new issue.

@ShadowApex
ShadowApex force-pushed the shadowapex/material-for-mkdocs branch from 19eec57 to d948e39 Compare January 22, 2026 15:40
@ShadowApex
ShadowApex merged commit 5796347 into main Jan 22, 2026
3 checks passed
@ShadowApex
ShadowApex deleted the shadowapex/material-for-mkdocs branch January 22, 2026 15:41
@github-actions

github-actions Bot commented Mar 2, 2026

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.44.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants