Fix ReadTheDocs (#18)

_scripts/fake-docs/conf.py

@@ -0,0 +1 @@
+"""A fake configuration for sphinx."""

_scripts/fake-docs/index.rst

@@ -0,0 +1,4 @@
+Not Docs
+========
+
+This exists for ReadTheDocs to build, and is replaced with the real docs.

docs/.readthedocs.yaml

@@ -0,0 +1,35 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  apt_packages:
+    - libasound2
+    - libatk1.0-0
+    - libcups2
+    - libdbus-glib-1-2
+    - libgtk-3-0
+    - libnss3
+    - libpangocairo-1.0-0
+    - libx11-xcb1
+    - libxcomposite1
+    - libxcursor1
+    - libxdamage1
+    - libxi6
+    - libxrandr2
+    - libxss1
+    - libxtst6
+  tools:
+    python: mambaforge-latest
+  jobs:
+    pre_build:
+      - pixi install --environment=rtd
+      - pixi run --environment=rtd build
+      - pixi run --environment=rtd docs-lite
+      - pixi run --environment=rtd docs-sphinx
+    post_build:
+      - pixi run --environment=rtd fake-docs-post-build
+sphinx:
+  builder: html
+  configuration: _scripts/fake-docs/conf.py
+conda:
+  environment: docs/environment.yml

docs/environment.yml

@@ -0,0 +1,5 @@
+channels:
+  - conda-forge
+  - nodefaults
+dependencies:
+  - pixi ==0.21.1

pixi.toml

@@ -208,17 +208,22 @@ outputs = ["build/docs/.buildinfo"]
 cwd = "docs"
 cmd = """
   export PYDEVD_DISABLE_FILE_VALIDATION=1
-  && sphinx-build -W --color -b html . ../build/docs"""
+  && sphinx-build -W --keep-going --color -b html . ../build/docs"""
 
 [feature.demo.tasks.lab]
 depends-on = ["pip"]
 cmd = "jupyter lab --no-browser --debug"
 
-[feature.docs.tasks.readthedocs]
-depends-on = ["build", "docs-lite"]
+[feature.rtd.tasks.fake-docs-build]
 cmd = """
-  export PYDEVD_DISABLE_FILE_VALIDATION=1
-  && sphinx-build -W --color -b html docs $READTHEDOCS_OUTPUT/html
+  rm -rf build/fake-docs
+  && python -m sphinx -W --keep-going --color -b html ./_scripts/fake-docs ./build/fake-docs
+"""
+
+[feature.rtd.tasks.fake-docs-post-build]
+cmd = """
+  rm -rf $READTHEDOCS_OUTPUT/html
+  && cp -r build/docs $READTHEDOCS_OUTPUT/html
 """
 
 ### environments for tasks
@@ -244,6 +249,16 @@ docs = {features = [
   "run",
   "webdriver",
 ], solve-group = "default"}
+rtd = {features = [
+  "build",
+  "demo",
+  "dev",
+  "docs",
+  "firefox-oldest",
+  "run",
+  "webdriver",
+  "rtd",
+], solve-group = "default"}
 test-oldest = {features = [
   "dev",
   "firefox-oldest",
@@ -319,3 +334,6 @@ importnb = "*"
 [feature.demo.dependencies]
 ipywidgets = ">=8.1,<8.2"
 jupyterlab = ">=4.1,<4.2"
+
+[feature.rtd]
+platforms = ["linux-64"]

pyproject.toml

@@ -122,7 +122,7 @@ extend-include = [
   "*.ipynb",
 ]
 include = [
-  "_scripts/*.*",
+  "_scripts/*.py",
   "contrib/*/src/**/*.py",
   "contrib/*/tests/**/*.py",
   "docs/**/*.py",

tests/test_repo.py

@@ -8,7 +8,7 @@
 
 PIXI_PATTERNS = {
     ".github/workflows/*.yml": r"JLPL_PIXI_VERSION: ([^\s]+)",
-    "docs/.readthedocs.yml": r"pixi==([^\s]+)",
+    "docs/environment.yml": r"pixi ==([^\s]+)",
     "CONTRIBUTING.md": r"pixi==([^\s]+)",
 }