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 12, 2024 · 608fdf1 · 608fdf1
1 parent 62afeb0
commit 608fdf1
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
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,6 +11,8 @@ build:
   tools:
     golang: "1.21"
     python: "3.11"
+  commands:
+    - pip install gitpython
   jobs:
     post_checkout:
       - cd doc; python3 .sphinx/build_requirements.py