External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-05-19 14:57:39 -02:30
Code Issues Packages Projects Releases Wiki Activity

Publish open api spec on AWX for community use (#16221)

Browse Source 
* Added link and ref to openAPI spec for community

* Update docs/docsite/rst/contributor/openapi_link.rst

Co-authored-by: Don Naro <dnaro@redhat.com>

* add sphinxcontrib-redoc to requirements

* sphinxcontrib.redoc configuration

* create openapi directory and files

* update download script for both schema files

* suppress warning for redoc

* update labels

* fix extra closing parenthesis

* update schema url

* exclude doc config and download script

The Sphinx configuration (conf.py) and schema download script
(download-json.py) are not application logic and used only for building
documentation. Coverage requirements for these files are overkill.

* exclude only the sphinx config file

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
This commit is contained in:
TVo
2026-01-26 11:16:49 -07:00
committed by GitHub
parent ceed692354
commit 12a7229ee9
10 changed files with 95 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docsite/requirements.in
View File

@@ -3,6 +3,8 @@
sphinx # Tooling to build HTML from RST source.
sphinx-ansible-theme # Ansible community theme for Sphinx doc builds.
sphinx-notfound-page # Sphinx extension for custom 404 page.
sphinxcontrib-redoc # Renders OpenAPI spec in human readable format.
setuptools >= 65.0 # Provides pkg_resources module for compatibility. Needed by sphinxcontrib-redoc.
docutils # Tooling for RST processing and the swagger extension.
Jinja2 # Requires investigation. Possibly inherited from previous repo with a custom theme.
PyYaml # Requires investigation. Possibly used as tooling for swagger API reference content.