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

feat(docs): Add MkDocs template site #126

Closed
wants to merge 5 commits into from
Closed

feat(docs): Add MkDocs template site #126

wants to merge 5 commits into from

Conversation

dfinster
Copy link
Member

Add a skeleton MkDocs documentation template site.

To run locally:

$ pip install mkdocs
$ pip install mkdocs-material
$ pip install mkdocs-mermaid2-plugin
$ mkdocs serve

@dfinster dfinster requested a review from Eta0 April 18, 2024 19:36
@Eta0
Copy link
Contributor

Eta0 commented Apr 19, 2024

All of our docstring documentation is written as reStructuredText, so mkdocstrings is not currently applicable.

@dfinster
Copy link
Member Author

dfinster commented Jul 9, 2024

Closing, no longer needed.

@dfinster dfinster closed this Jul 9, 2024
@dfinster dfinster deleted the df/mkdocs branch July 9, 2024 20:29
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