summaryrefslogtreecommitdiffstats
path: root/docs/requirements-docs.txt
AgeCommit message (Collapse)AuthorFilesLines
2021-02-02[COMMON] Fix tox docs profiles configurationGuillaume Lambert1-1/+1
- sphinx-build '-W' option needed only once - remove docs/tox.ini since * same profiles are declared in tox.ini * once run from the docs folder, this generates invalid files in doc/.tox for linters setup (e.g. docs/.tox/[..]/invalid.rst). They can cause warnings treated as errors by root tox profiles. - modify requirements.txt to force a sphinxcontrib-needs version prior to 0.6.0 . This latest version introduces a new services support functionality that cannot be easily disabled here and that requires additional configuration parameters to link GitHub issues. We cannot provide these parameters since this project uses JIRA. As a result, sphinx generates a warning treated as an error that makes the gate fail. https://sphinxcontrib-needs.readthedocs.io/en/service/services/index.html Issue-ID: OOM-2648 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I14e9045482750f15a3e5e98af47197e2c9f60f60
2020-12-09[COMMON] Add doc lintingSylvain Desbureaux1-0/+1
Add 3 automated doc linting (sphinx building, linkchecking and doc8) in order to have an error free documentations Fix also issues found by these linters in order to start without errors. Issue-ID: OOM-2648 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I318718c956020412a120ba3caeb9e21d35a99833
2020-02-10Migrate oom docsJessica Wagantall1-0/+15
Merging this will create https://onap-oom.readthedocs.io This build will run in parallel to the current docs generation method until we are ready to cut over. Issue-ID: CIMAN-364 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: I502ea73223a2fe2f7f8d235a3544a186ae3d45c1