Skip to content

Setup mkdocs#167

Merged
ankoure merged 5 commits intomainfrom
setup-mkdocs
Mar 7, 2026
Merged

Setup mkdocs#167
ankoure merged 5 commits intomainfrom
setup-mkdocs

Conversation

@ankoure
Copy link
Copy Markdown
Contributor

@ankoure ankoure commented Feb 14, 2026

The goal of this PR is to set up MKDocs so that we can have autogenerated documentation based on pylance types and docstrings.

image

@ankoure ankoure marked this pull request as ready for review February 14, 2026 16:55
Comment thread docs/index.md
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we not just use the README? Or does it require being copied?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Great question! Apparently we can reference the README instead of copying. I hadn't thought of that so thanks!

@ankoure ankoure merged commit 9d55528 into main Mar 7, 2026
5 checks passed
@ankoure ankoure deleted the setup-mkdocs branch March 7, 2026 20:07
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.

2 participants