Documentation
Load dev/documentation.md for detailed guidance on docstrings and markdown
formatting.
Procedure
- •
Run
make doc - •
If spell check fails: add new terms to
project-words.txt(do NOT sort it) - •
If new module was created: ensure
docs/api/entry ANDmkdocs.ymlnav updated - •
Repeat until
make docpasses
Exit Conditions
- •Success:
make docpasses - •Failure: Report remaining errors clearly