Age | Commit message (Collapse) | Author | Files | Lines |
|
It leverages the latest change from lfdocs-conf and the
upper-constraints.txt now centralized in ONAP docs.
In a long run, upperconstraints.os.txt should be removed once ONAP
is synced with OpenStack.
docs/requirements-docs.txt is renamed requirements.txt as it mixes
both docs and linter dependencies.
It removes tox and setuptools from requirements as nothing depends on them
(most requirements should be removed except lfdocsconf)
Issue-ID: DOC-765
Change-Id: Iae808297484f4798de82a43597ccad7905ff4c94
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
|
|
- force lfdocs-confr~=0.7.5 in docs/requirements-docs.txt
- add funcparserlib==1.0.0a0 in docs/requirements-docs.txt
- enforce compatible versions in other listed packages
Issue-ID: DOC-765
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: If3c9758cb9d691b222b04a22145f33cfb4f2a72b
|
|
- move doc8 dependency from docs/requirements-docs.txt to tox.ini
since it is not needed by other tox profiles
- disable doc8 tox profile voting since linelength issues are not
completely fixed yet
- fix a few linelength issues
Issue-ID: DOC-765
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I704fc2ee8087ffbb8a83d693f6dc5a5f7c992b10
|
|
- 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
|
|
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
|
|
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
|