Example output logs¶
This sections demonstrates what output logs look like when included in documentation generated by sphinx.
Assumptions and caveats log¶
The example assumtions and caveats log is generated from the root of this project using:
assumptions -e .py -o docs/source/example/assumptions_caveats_log.md
Technical debt log¶
The example technical debt log is generated from the root of this project using:
assumptions -e .py -o docs/source/example/technical_debt_log.md -l technical_debt_log
Todo list¶
The example todo list is generated from the root of this project using:
assumptions -e .py -o docs/source/example/todo_list.md -l todo_list