diff options
| -rw-r--r-- | docs/docsite/conf.py | 3 | ||||
| -rw-r--r-- | docs/docsite/rst/rest_api/_swagger/awx-rest-api.css (renamed from docs/docsite/rst/rest_api/_swagger/tower.css) | 0 | ||||
| -rw-r--r-- | docs/docsite/rst/rest_api/_swagger/download-json.py | 13 | ||||
| -rw-r--r-- | docs/docsite/rst/rest_api/api_ref.rst | 4 | ||||
| -rw-r--r-- | docs/docsite/rst/rest_api/index.rst | 2 | ||||
| -rw-r--r-- | tox.ini | 1 |
6 files changed, 18 insertions, 5 deletions
diff --git a/docs/docsite/conf.py b/docs/docsite/conf.py index 74553d56b1..2a733792ed 100644 --- a/docs/docsite/conf.py +++ b/docs/docsite/conf.py @@ -5,7 +5,7 @@ import shlex from datetime import datetime from importlib import import_module -#sys.path.insert(0, os.path.abspath('./rst/rest_api/_swagger')) +sys.path.insert(0, os.path.abspath('./rst/rest_api/_swagger')) project = u'Ansible AWX' copyright = u'2023, Red Hat' @@ -35,6 +35,7 @@ extensions = [ 'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx_ansible_theme', + 'swagger', ] html_theme = 'sphinx_ansible_theme' diff --git a/docs/docsite/rst/rest_api/_swagger/tower.css b/docs/docsite/rst/rest_api/_swagger/awx-rest-api.css index 06af18fa26..06af18fa26 100644 --- a/docs/docsite/rst/rest_api/_swagger/tower.css +++ b/docs/docsite/rst/rest_api/_swagger/awx-rest-api.css diff --git a/docs/docsite/rst/rest_api/_swagger/download-json.py b/docs/docsite/rst/rest_api/_swagger/download-json.py new file mode 100644 index 0000000000..47ded50a2a --- /dev/null +++ b/docs/docsite/rst/rest_api/_swagger/download-json.py @@ -0,0 +1,13 @@ +import requests + +url = "https://awx-public-ci-files.s3.amazonaws.com/community-docs/swagger.json" +swagger_json = "./docs/docsite/rst/rest_api/_swagger/swagger.json" + +response = requests.get(url) + +if response.status_code == 200: + with open(swagger_json, 'wb') as file: + file.write(response.content) + print(f"JSON file downloaded to {swagger_json}") +else: + print(f"Request failed with status code: {response.status_code}") diff --git a/docs/docsite/rst/rest_api/api_ref.rst b/docs/docsite/rst/rest_api/api_ref.rst index 144d21854f..5b049e6ae4 100644 --- a/docs/docsite/rst/rest_api/api_ref.rst +++ b/docs/docsite/rst/rest_api/api_ref.rst @@ -1,5 +1,3 @@ -:orphan: - .. _api_reference: AWX API Reference Guide @@ -48,7 +46,7 @@ The API Reference Manual provides in-depth documentation for the AWX REST API, i <script> window.onload = function() { $('head').append('<link rel="stylesheet" href="../_static/swagger-ui.css" type="text/css"></link>'); - $('head').append('<link rel="stylesheet" href="../_static/tower.css" type="text/css"></link>'); + $('head').append('<link rel="stylesheet" href="../_static/awx-rest-api.css" type="text/css"></link>'); $('#swagger-ui').on('click', function(e) { // By default, swagger-ui has a show/hide toggle for headers, and // there's no way to turn it off; this code intercepts the click event diff --git a/docs/docsite/rst/rest_api/index.rst b/docs/docsite/rst/rest_api/index.rst index 5a3031a275..73e4ef3d08 100644 --- a/docs/docsite/rst/rest_api/index.rst +++ b/docs/docsite/rst/rest_api/index.rst @@ -31,7 +31,7 @@ You can also find lots of AWX discussion and get answers to questions at `forum. access_resources read_only_fields authentication -.. api_ref + api_ref .. intro .. auth_token @@ -35,4 +35,5 @@ deps = -r{toxinidir}/docs/docsite/requirements.in -c{toxinidir}/docs/docsite/requirements.txt commands = + python {toxinidir}/docs/docsite/rst/rest_api/_swagger/download-json.py sphinx-build -T -E -W -n --keep-going {tty:--color} -j auto -c docs/docsite -d docs/docsite/build/doctrees -b html docs/docsite/rst docs/docsite/build/html |