logo

... docs: watch



Notes

To make sure that the docs automatically update you'll need to ensure that these lines of code are in your mkdocs.yml file.

plugins:
- mkdocstrings:
    watch:
      - clumper

In order for this to work, you will need to make sure that the plugins are properly installed via pip.

python -m pip install mkdocstrings

If you're developing the package this will automatically be installed when running:

make develop

Feedback? See an issue? Something unclear? Feel free to mention it here.



If you want to be kept up to date, consider signing up for the newsletter.