Skip to content
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

[Feature]: Generate docs for Python via mkdocs #11

Open
thinkjrs opened this issue Aug 8, 2021 · 0 comments
Open

[Feature]: Generate docs for Python via mkdocs #11

thinkjrs opened this issue Aug 8, 2021 · 0 comments
Assignees

Comments

@thinkjrs
Copy link
Member

thinkjrs commented Aug 8, 2021

We need to generate docs from inline python docstrings. A nice tool to get the job done is mkdocs with the material theme.

https://squidfunk.github.io/mkdocs-material/
and https://github.com/mkdocstrings/mkdocstrings.

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

No branches or pull requests

1 participant