Search⌘ K
AI Features

Commands for Testing: Documentation

Explore methods to automate documentation updates with Git pre-commit hooks. Understand how to avoid infinite loops while ensuring docs stay current, so your code base remains reliable and well documented.

Documentation

Before moving on, let’s consider the documentation. ​​If any of the doc strings have been altered, it would be good to update the documentation.

pre-commit script

If we want, we can add the following lines in pre-commit to compile the documentation.

$ cd flask-examples/docs
$ make html
$ cd ..

This ...