doc: work around circular dependency

Manually install gitpython, because it must be available to generate the requirements.txt file, which is before the venv is created. Issue for this is here: canonical/sphinx-docs-starter-pack#197 Signed-off-by: Ruth Fuchss <[email protected]>
ru-fu · Mar 13, 2024 · c37d154 · c37d154
1 parent 62afeb0
commit c37d154
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -131,6 +131,7 @@ update-metadata: build
 .PHONY: doc-setup
 doc-setup: client
 	@echo "Setting up documentation build environment"
+	pip3 install gitpython
 	cd doc; LOCAL_SPHINX_BUILD=True python3 .sphinx/build_requirements.py
 	python3 -m venv doc/.sphinx/venv
 	. $(SPHINXENV) ; pip install --require-virtualenv --upgrade -r doc/.sphinx/requirements.txt --log doc/.sphinx/venv/pip_install.log

diff --git a/doc/.readthedocs.yaml b/doc/.readthedocs.yaml
@@ -11,8 +11,12 @@ build:
   tools:
     golang: "1.21"
     python: "3.11"
+  apt_packages:
+    - python3-pip
   jobs:
-    post_checkout:
+    pre_install:
+      - apt list --installed
+      - pip install gitpython pyyaml
       - cd doc; python3 .sphinx/build_requirements.py
     pre_build:
       - go build -ldflags "-s -w" -o trimpath -o lxc.bin ./lxc

diff --git a/doc/custom_conf.py b/doc/custom_conf.py
@@ -196,6 +196,7 @@
 # sphinxext-opengraph
 custom_required_modules = [
     'gitpython',
+    'pyyaml',
     'sphinx-remove-toctrees'
 ]