Healthy Meals documentation
Add your content using Sphinx enhanced reStructuredText syntax.
Table of Contents
Contents:
- Quality Assurance
- Index
- Module Index
- Modules
- Programmers Guide
- Nox Automation
- Pull Requests (for code and documentation)
- Programmers Guide To Do Items:
- uv
- Continuous Integration
- README.md (in github)
- To Do Lists
- How “todo” items get into sphinx docs
- How to enter a “todo” item into .rst (reStructuredText) files
- How to enter “todo” items into code documentation (in docstrings)
- All To Do items (from Code and Programmers Guide):
- Testing Guide
- Documentation Guide
- Code Documentation Philosophy
- Code Documentation Process Overview
- Example Google Style Docstring for a function:
- Generation of the Documentation.
- Understanding the custom .rst anc config files (docs_guide.rst, index.rst, and conf.py)
- Sphinx & Restructured Text (rst) guides and resources:
- Deployment to Github Pages: