From d1f93f4febdd5b34e96b954dd11e635bc0ee8041 Mon Sep 17 00:00:00 2001 From: "Lovett, Trevor" Date: Thu, 2 Jul 2020 11:19:00 -0500 Subject: Requirement ID Generation and RST Validation The new check.py script will now perform a variety of actions to simplify updates and ensure specific practices are followed for each update. The script has been integrated with tox and will run whenever the documentation is created. It can also be ran separately by just invoking python check.py. The script will perform a variety of automatic updates where possible, and provide a warning where auto-updates are not possible. The expecation is that all warnings are addressed before submitting for review, but given it is a new feature warnings do not block validation at this time. Here is a summary of the warnings and updates: Warnings: - Requirement missing required attributes - Invalid values for attributes - Invalid section header usage in any file - :keyword: and requirement mismatch Auto Updates: - Assigning :id: on new requirements where an ID missing - Adding :introduced: attribute on new requirements - Adding/correcting :updated: attribute on changed requirements Issue-ID: VNFRQTS-896 Signed-off-by: Lovett, Trevor Change-Id: I283441330a139aa1c6e2e79f0c54c5979bf44642 --- tox.ini | 2 ++ 1 file changed, 2 insertions(+) (limited to 'tox.ini') diff --git a/tox.ini b/tox.ini index 64bd324..d5621f9 100644 --- a/tox.ini +++ b/tox.ini @@ -26,10 +26,12 @@ deps = -r{toxinidir}/etc/requirements.txt commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/_build/html" + python check.py whitelist_externals = echo git sh + python [testenv:needs] basepython = python3 -- cgit 1.2.3-korg