predict-idlab / plotly-resampler

Visualize large time series data with plotly.py
https://predict-idlab.github.io/plotly-resampler/latest
MIT License
1k stars 67 forks source link

Docs: Admonitions not rendering correctly #241

Closed NielsPraet closed 1 year ago

NielsPraet commented 1 year ago

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.