Skip to content

convert docs to markdown, build using mkdocs and add action to publish to astral-sh/docs - #1234

Open
jjhelmus wants to merge 2 commits into
mainfrom
jjh/mkdocs
Open

jjhelmus wants to merge 2 commits into
mainfrom
jjh/mkdocs

Conversation

@jjhelmus

@jjhelmus jjhelmus commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Covert the project documentation to markdown from restructured text.
Build the project documentation using mkdocs, previously sphinx was used.
Add a new action to build and publish documentation to astral-sh/docs. This action was based largely off the action from ruff.

@jjhelmus jjhelmus changed the title convert docs to markdown and build using mkdocs convert docs to markdown, build using mkdocs and add action to publish to astral-sh/docs Sep 10, 2026
@jjhelmus
jjhelmus marked this pull request as ready for review September 10, 2026 18:10
@jjhelmus
jjhelmus requested review from zanieb and zsol September 10, 2026 18:10
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.

1 participant