logo

... docs.


Documentation is more important than most people are willing to admit. If you want your project to be used though, you to invest in it. As a bonus, you might also be able to get some good unit tests for free too. In this series of video's we'll highlight how we've set up documentation for clumper.


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 getting the newsletter.