doc: docs tooling and configuration updates

.github/workflows/tests.yml

@@ -297,6 +297,7 @@ jobs:
     with:
       working-directory: './doc'
       makefile: 'Makefile'
+      python-version: '3.12'
 
   snap:
     name: Trigger snap edge build

doc/.custom_wordlist.txt

@@ -79,6 +79,7 @@ SDN
 snapd
 SSD
 SSL
+subfolders
 subnet
 subnets
 SVG

doc/.gitignore

@@ -1,8 +1,6 @@
 /*env*/
-.sphinx/venv/
-.sphinx/requirements.txt
+.venv/
 .sphinx/warnings.txt
-.sphinx/.wordlist.dic
 .sphinx/.doctrees/
 .sphinx/node_modules/
 package*.json
@@ -14,6 +12,5 @@ __pycache__
 .sphinx/styles/*
 .sphinx/vale.ini
 integration/
-
 .sphinx/deps/
 _static/swagger-ui

doc/.readthedocs.yaml

@@ -15,12 +15,7 @@ build:
       - git fetch --unshallow || true
       - cd doc && make GOTOOLCHAIN=auto integrate
       - cd doc/integration/lxd/ && GOTOOLCHAIN=auto go build -ldflags "-s -w" -o trimpath -o lxc.bin ./lxc
-      # Pretend that woke is installed - we don't need it for building
-      # (workaround until https://github.com/canonical/microovn/pull/168 is merged
-      # and https://github.com/canonical/microceph/pull/400 is restored)
-      - ln -s /bin/true doc/integration/microovn/docs/woke
-      - ln -s /bin/true doc/integration/microceph/docs/woke
-      - make GOTOOLCHAIN=auto doc-html-rtd PATH=$PATH:.
+      - cd doc && make GOTOOLCHAIN=auto html-rtd PATH=$PATH:.
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -35,4 +30,4 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: doc/.sphinx/requirements.txt
+   - requirements: doc/requirements.txt

doc/.sphinx/_integration/add_config.py

@@ -11,22 +11,18 @@
 
 if project == "LXD":
     html_baseurl = "https://documentation.ubuntu.com/lxd/latest/"
-    html_js_files.append('rtd-search.js')
     html_css_files = globals().get('html_css_files', []) + ['override-header.css']
     tags.add('integrated')
 elif project == "MicroCeph":
-    html_baseurl = "https://canonical-microceph.readthedocs-hosted.com/en/latest/"
+    html_baseurl = "https://canonical-microceph.readthedocs-hosted.com/latest/"
     # Override default header templates
-    templates_path = globals().get('templates_path', []) + [".sphinx/_templates"]
+    templates_path = globals().get('templates_path', []) + ["_templates"]
     # Override default header styles
-    html_static_path = globals().get('html_static_path', []) + [".sphinx/_static"]
+    html_static_path = globals().get('html_static_path', []) + ["_static"]
     html_css_files = globals().get('html_css_files', []) + ['override-header.css']
-    # Add rtd-search.js to the list of JS files
-    html_js_files = globals().get('html_js_files', []) + ['rtd-search.js']
     # Add "integrated" to the list of custom tags
-    custom_tags = globals().get('custom_tags', []) + ['integrated']
+    tags.add('integrated')
 elif project == "MicroOVN":
     html_baseurl = "https://canonical-microovn.readthedocs-hosted.com/en/latest/"
-    custom_html_js_files.append('rtd-search.js')
     custom_tags.append('integrated')