summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDon Naro <dnaro@redhat.com>2023-09-05 23:07:32 +0200
committerGitHub <noreply@github.com>2023-09-05 23:07:32 +0200
commit5733f78fd8341e91722ce8cabb0e6aaea760e0e9 (patch)
tree175a2027e5382acea059abe31786668261ff03a7
parentAdd check for building docsite (#14406) (diff)
downloadawx-5733f78fd8341e91722ce8cabb0e6aaea760e0e9.tar.xz
awx-5733f78fd8341e91722ce8cabb0e6aaea760e0e9.zip
Add readthedocs configuration (#14413)
-rw-r--r--.gitignore5
-rw-r--r--.readthedocs.yaml15
-rw-r--r--.yamllint1
3 files changed, 19 insertions, 2 deletions
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