Add readthedocs configuration (#14413)

ansible · Sep 5, 2023 · 5733f78 · 5733f78
1 parent 20fc7c7
commit 5733f78
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git 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/
+# Docs build stuff
+docs/docsite/build/
+_readthedocs/
diff --git a/.readthedocs.yaml 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
@@ -10,6 +10,7 @@ ignore: |
   tools/docker-compose/_sources
   # django template files
   awx/api/templates/instance_install_bundle/**
+  .readthedocs.yaml
 
 extends: default