A Sphinx extension allowing declaration if requirement specs wherever in the documentation (for instance, in docstrings of UnitTest.test_* methods) and collating them in a single list.
Install this package with pip:
pip install sphinxcontrib-requirementsand enable in project configuration (conf.py):
extensions = [
'sphinxcontrib.requirements',
]The requirements extension provides two new directives:
Defines an individual requirement to be processed.
The status option defines the disposition of the requirement. Values are
currently fixed to the following values:
undecided(default)tododonetestedwontfix
A future version shall have the ability to control the available options through
the Sphinx conf.py file.
The reference option allows an external document reference to be specified
such as a formal requirements document or specification.
The reqlist directive is replaced by a list of all the requirements that have
been found across the documentation. Much like the built-in todo extension,
this directive can only be processed properly if a complete build of the
documentation is run (i.e make clean is run first,) otherwise unchanged files
aren't processed.
No configuration is necessary at this time.