Skip to content

Add mkdocs configuration #63

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.

Sign up for GitHub

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

Jump to bottom
Open
pavelzw wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add mkdocs configuration #63

pavelzw wants to merge 5 commits into from

Conversation

@pavelzw
Copy link
Member

@pavelzw pavelzw commented Jul 13, 2024 •
edited
Loading

Some example configuration using mkdocs-material and numpy-style docstrings in combination with ruff's pydocstyle

TODO:

  • be able to reference classes/methods
  • interactive notebooks using something like myst or marimo?

@pavelzw pavelzw requested a review from 0xbe7a as a code owner July 13, 2024 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@0xbe7a 0xbe7a Awaiting requested review from 0xbe7a

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@pavelzw @thomasmarwitz