melexis / sphinx-traceability-extension

Traceability extension for Sphinx documentation generator
GNU General Public License v3.0
25 stars 9 forks source link

Rename item directive with requirement or testcase #357

Open Letme opened 11 months ago

Letme commented 11 months ago

As is indicated in our conf.py we can create a sphinx directive .. requirement:: instead of `.. item:: and use that to make it more human readable. The purpose of that would also be, that .. requirement:: directive should have required attributes (like functional) which other items would not have (for example testcase directive). We should expose this change to the Item directive so that in callback function (or even natively in plugin) we could enforce certain attributes, or append prefixes. For example directive .. requirement:: TITLE would end up prefixed with SOFTWARE_REQUIREMENT, so as .. item:: SOFTWARE_REQUIREMENT-TITLE and .. req:: TITLE would end up the same.