Chore: Add sphinxcontrib-openapi for API documentation 53/143053/6
authorMatthew Watkins <mwatkins@linuxfoundation.org>
Tue, 27 Jan 2026 15:27:35 +0000 (15:27 +0000)
committerHerbert Eiselt <herbert.eiselt@highstreet-technologies.com>
Tue, 3 Feb 2026 07:49:09 +0000 (07:49 +0000)
commit43ae207068598e1c3d05475c492f0a3539f24880
tree239fd10fc8af042044a249a3e75b7e8fc71b8e07
parent3fc949fcdb0ee208aeedee3a7fd23f57fc17e4fe
Chore: Add sphinxcontrib-openapi for API documentation

Replace the swaggerv2doc directive usage in genericresource.rst with
the actively maintained sphinxcontrib-openapi extension.

Changes:
- Add sphinxcontrib-openapi==0.7.0 to requirements and conf.py
  (pinned to avoid sphinx-mdinclude/docutils incompatibility)
- Add POSIX-compatible download script to fetch OpenAPI specs during build
- Update genericresource.rst to use openapi directive
- Remove unnecessary OpenStack yoga constraints from docs tox.ini
- Retain sphinxcontrib-swaggerdoc module (removal in separate change)

Issue-ID: CIMAN-33
Change-Id: Ic4b1a5ae8740bce998cf179262e3c9beb8716e47
Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>
docs/apis/genericresource.rst
docs/conf.py
docs/requirements-docs.txt
docs/specs/.gitignore [new file with mode: 0644]
docs/specs/download-specs.sh [new file with mode: 0755]
docs/tox.ini