Docs: Add sphinx-needs migration guide and constraints 65/143565/1
authorMatthew Watkins <mwatkins@linuxfoundation.org>
Tue, 10 Mar 2026 10:03:37 +0000 (10:03 +0000)
committerMatthew Watkins <mwatkins@linuxfoundation.org>
Tue, 10 Mar 2026 10:03:37 +0000 (10:03 +0000)
commit10a0dcc5f03dc1ac63a4f855a00ad0affa5a0c6c
tree47325e8ebb118ceeaa4a3cc7fc340ae68eff79be
parent545a80b47643beb325cdd159e43159f931a8d9bb
Docs: Add sphinx-needs migration guide and constraints

Add migration guide for replacing the abandoned sphinxcontrib-needs
package with its maintained successor sphinx-needs. The old package
fails on modern Python environments due to:

- pkg_resources import (removed from setuptools>=82)
- sphinx.util.status_iterator import (removed from Sphinx 8.2+)

Both issues break Read the Docs builds, which upgrade setuptools and
Sphinx to latest versions before processing requirements-docs.txt.

Changes:
- New guide: needs-sphinxcontrib-to-sphinx-needs.rst with full
  migration steps, background, and affected repository tracking
- upper-constraints.onap.txt: Add sphinx-needs==7.0.0 pin
- diagrams-blockdiag-to-mermaid.rst: Add seealso cross-reference
  to the new sphinx-needs migration guide
- index.rst: Add new guide to documentation toctree

Issue-ID: CIMAN-33
Change-Id: Iaddb82bd98a92d394f480059643b4f7cf87e4d64
Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>
docs/guides/onap-documentation/diagrams-blockdiag-to-mermaid.rst
docs/guides/onap-documentation/index.rst
docs/guides/onap-documentation/needs-sphinxcontrib-to-sphinx-needs.rst [new file with mode: 0644]
etc/upper-constraints.onap.txt