From 5733f78fd8341e91722ce8cabb0e6aaea760e0e9 Mon Sep 17 00:00:00 2001 From: Don Naro Date: Tue, 5 Sep 2023 22:07:32 +0100 Subject: [PATCH] Add readthedocs configuration (#14413) --- .gitignore | 5 +++-- .readthedocs.yaml | 15 +++++++++++++++ .yamllint | 1 + 3 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.gitignore b/.gitignore index 7308b4c193..b41763166c 100644 --- a/.gitignore +++ b/.gitignore @@ -166,5 +166,6 @@ use_dev_supervisor.txt awx/ui_next/src awx/ui_next/build -# Docs build -docs/docsite/build/ \ No newline at end of file +# Docs build stuff +docs/docsite/build/ +_readthedocs/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..0c11aab82f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: >- + 3.11 + commands: + - pip install --user tox + - python3 -m tox -e docs + - mkdir -p _readthedocs/html/ + - mv docs/docsite/build/html/* _readthedocs/html/ diff --git a/.yamllint b/.yamllint index fdfbfce43a..a937588cdc 100644 --- a/.yamllint +++ b/.yamllint @@ -10,6 +10,7 @@ ignore: | tools/docker-compose/_sources # django template files awx/api/templates/instance_install_bundle/** + .readthedocs.yaml extends: default