Skip to content

Docs: Admonitions not rendering correctly #241

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

Closed
NielsPraet opened this issue Jul 11, 2023 · 0 comments · Fixed by #245
Closed

Docs: Admonitions not rendering correctly #241

NielsPraet opened this issue Jul 11, 2023 · 0 comments · Fixed by #245
Labels
documentation Improvements or additions to documentation

Comments

@NielsPraet
Copy link
Collaborator

Currently, admonitions in the numpy docstrings are not rendered correctly on:

mkdocs = "^1.4.3"
mkdocstrings = { version = "^0.20.0", extras = ["python"] }
mkdocs-material = "^9.1.18"

figure resampler admonition example

On the mkdocstrings documentation, it is stated that admonitions in docstrings are currently (only) supported in Google docstrings. As this project uses Numpy docstrings, we should follow this up when new mkdocstrings versions release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant