Research: Sphinx #2
Description
User story
- As a team
- We need an easily maintainable documentation system for the code
- So we can easily generate high quality documentation
Acceptance criteria
- Do some research on Sphinx
- Also do some research on other python documentation systems and decide whether there is something better than Sphinx for our project
Definition of done (DoD)
A feature is considered complete when
- All of its acceptance criteria have been met.
- It has been thoroughly tested.
- The code has been peer reviewed by the dedicated team.
- It can be seamlessly integrated into the main branch without causing any negative side effects.
- Its core functionality has been thoroughly documented.
DoD general criteria
- Feature has been fully implemented
- Feature has been merged into the mainline
- All acceptance criteria were met
- Product owner approved features
- All tests are passing
- Developers agreed to release