chore(docs): readthedocs uses hatch env (DataDog#6963)

majorgreys · web-flow · commit 683489db75cd · 2023-09-21T16:52:28.000-04:00
This change makes our readthedocs match the docs builds in CI. In order to make this change, we had to change a few things about how the hatch docs env was configured and skip installing system packages in readthedocs that we don't need. Build preview: https://ddtrace.readthedocs.io/en/majorgreys-readthedocs-hatch/integrations.html Fixes DataDog#6897. ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) - [x] If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from `@DataDog/security-design-and-guidance`. - [x] This PR doesn't touch any of that.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,20 +1,10 @@
 version: 2
-
-sphinx:
-  builder: html
-  configuration: docs/conf.py
-  fail_on_warning: false
-
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
-  jobs:
-    post_checkout:
-      - git fetch --unshallow || true
-
-python:
-  install:
-    - requirements: docs/requirements.txt
-    - method: pip
-      path: .
+    python: "3.10"
+  commands:
+    - git fetch --unshallow || true
+    - pip install hatch==1.7.0 hatch-containers==0.7.0
+    - hatch -v run docs:sphinx-build -W -b html docs docs/_build/html
+    - mv docs/_build $READTHEDOCS_OUTPUT
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/hatch.toml b/hatch.toml
@@ -60,7 +60,6 @@ fmt = [
 ]
 
 [envs.docs]
-type = "container"
 template = "docs"
 dev-mode = false
 python = "3.10"
@@ -84,12 +83,8 @@ build = [
 ]
 
 [envs.docs.overrides]
-# CircleCI executor is an image already set up for docs
-# We skip the pre-install as well
-env.CIRCLECI.type = [
-    { value = "virtual", if = ["true"] },
-]
-
+# Local MacOS development requires Docker containers
+platform.macos.type = { value = "container" }
 
 [envs.slotscheck]
 template = "slotscheck"
diff --git a/scripts/docs/install.sh b/scripts/docs/install.sh
@@ -4,6 +4,9 @@ set -ex
 
 if [[ "${CIRCLECI}" = "true" ]]; then
     echo "Skipping install"
+elif [[ "${READTHEDOCS}" = "True" ]]; then
+    # We skip here because we do not check spelling in RTD
+    echo "Skipping install"
 else
     export DEBIAN_FRONTEND="noninteractive"
     export DEBCONF_NOWARNINGS="yes"
