To Do Lists

How “todo” items get into sphinx docs

conf.py configuration (docs/conf.py)

extensions = [
    "sphinx.ext.autodoc", # to get items from docstrings
    ...
    "sphinx.ext.todo", # see: https://www.sphinx-doc.org/en/master/usage/extensions/todo.htm
]
todo_include_todos = True   # see: https://www.sphinx-doc.org/en/master/usage/extensions/todo.htm

How to enter a “todo” item into .rst (reStructuredText) files

If a .rst file has the following code:

Example To Do List:

.. ToDo:: Example single row todo item

.. ToDo:: Example labeled bulleted todo list:

   - Example Item 1
   - Example Item 2

How to enter “todo” items into code documentation (in docstrings)

If python has the following docstring:

'''Example "todo" items in a python docstring style comment

.. ToDo:: Example single row todo item

.. ToDo:: Example labeled bulleted todo list:

    - Example Item 1
    - Example Item 2
'''

All To Do items (from Code and Programmers Guide):

Todo

replace accounts.models.CustomUserManager.all_deleted with SafeDeleteManager.deleted_only()

see: https://django-safedelete.readthedocs.io/en/latest/managers.html
note: these functions are only found in model manager classes
thus: all models must declare their custom manager based off of SafeDeleteManager

(The original entry is located in /home/runner/work/healthy-meals/healthy-meals/accounts/models.py:docstring of accounts.models.CustomUserManager.all_deleted, line 3.)

Todo

Starter or Introduction items todo list:

ongoing enhancements to documentation - Helpful developer guidance - better coverage - improved developer setup instructions
- pip tools being used with UV?
- replace asdf with UV
getting MyPy QA/lint tool working
getting Ruff QA/lint tool working
getting any other worthwhile QA tools working
update developer setup instructions in README.md (pip tools?, not using asdf, windows, using hatch, …)

(The original entry is located in /home/runner/work/healthy-meals/healthy-meals/docs/source/prog_prs.rst, line 58.)

Todo

Configuration items todo list:

write guidance in programmer docs for getting coverage of HTML files
github pages cleanup
- do not overwrite production docs during pull requests
- consider having pull request version of documentation for review
- delete docs build artifact after upload to pages (maybe it needs a name and delete artifact action?)
turn on circle CI validation
consider turning on other CI
nox automated testing coverage - confirm all scripts have a returncode of 0 - note slow docker scripts!
nox “status” script to validate git environment - remotes set up properly - current local branch up to date for pull requests - main branch up to date for pull requests - warning to not do pull request if automated testing errors - warning to not do pull request if coverage below a certain percentage - handle updates to new “starter” branch

(The original entry is located in /home/runner/work/healthy-meals/healthy-meals/docs/source/prog_prs.rst, line 72.)