docs: update sphinx theme (#4367)

Signed-off-by: Callahan Kovacs <[email protected]> Co-authored-by: David Boddie <[email protected]> Co-authored-by: Callahan Kovacs <[email protected]> Co-authored-by: Alex Lowe <[email protected]>
canonical · Sep 22, 2023 · aa64666 · aa64666
1 parent e340be1
commit aa64666
Show file tree

Hide file tree

Showing 11 changed files with 169 additions and 242 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,6 @@
 [submodule "tests/spread/tools/snapd-testing-tools"]
 	path = tests/spread/tools/snapd-testing-tools
 	url = https://github.com/snapcore/snapd-testing-tools.git
+[submodule "docs/sphinx-resources"]
+	path = docs/sphinx-resources
+	url = https://github.com/canonical/sphinx-docs-starter-pack.git
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -4,6 +4,10 @@
 ---
 version: 2
 
+submodules:
+  include:
+    - docs/sphinx-resources
+
 build:
   os: ubuntu-22.04
   tools:
@@ -19,5 +23,5 @@ sphinx:
 
 python:
   install:
-    - requirements: docs/.sphinx/requirements.txt
     - requirements: docs/requirements.txt
+    - requirements: docs/sphinx-resources/.sphinx/requirements.txt
diff --git a/docs/.sphinx/_static/custom.css b/docs/.sphinx/_static/custom.css
diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt
diff --git a/docs/.sphinx/spellingcheck.yaml b/docs/.sphinx/spellingcheck.yaml
diff --git a/docs/Makefile b/docs/Makefile
@@ -3,11 +3,11 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= -q
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
-VENV          = .sphinx/venv/bin/activate
+VENV          = sphinx-resources/.sphinx/venv/bin/activate
 
 
 # Put it first so that "make" without argument is like "make help".
@@ -16,8 +16,8 @@ help:
 
 install:
 	@echo "... setting up virtualenv"
-	python3 -m venv .sphinx/venv
-	. $(VENV); pip install --upgrade -r .sphinx/requirements.txt -r requirements.txt
+	python3 -m venv sphinx-resources/.sphinx/venv
+	. $(VENV); pip install --upgrade -r sphinx-resources/.sphinx/requirements.txt -r requirements.txt
 
 	@echo "\n" \
 		"--------------------------------------------------------------- \n" \
@@ -27,25 +27,36 @@ install:
                 "* clean built doc files: make clean-doc \n" \
                 "* clean full environment: make clean \n" \
 		"* check spelling: make spelling \n" \
+                "* check inclusive language: make woke \n" \
 		"--------------------------------------------------------------- \n"
 run:
-	. $(VENV); sphinx-autobuild -c . "$(SOURCEDIR)" "$(BUILDDIR)"
+	. $(VENV); sphinx-autobuild -c . -b html "$(SOURCEDIR)" "$(BUILDDIR)"
 
 html:
-	. $(VENV); $(SPHINXBUILD) -c . "$(SOURCEDIR)" "$(BUILDDIR)" -w .sphinx/warnings.txt
+	. $(VENV); $(SPHINXBUILD) -c . -b html "$(SOURCEDIR)" "$(BUILDDIR)" -w sphinx-resources/.sphinx/warnings.txt
+
+epub:
+	. $(VENV); $(SPHINXBUILD) -c . -b epub "$(SOURCEDIR)" "$(BUILDDIR)" -w sphinx-resources/.sphinx/warnings.txt
 
 serve:
 	cd "$(BUILDDIR)"; python3 -m http.server 8000
 
 clean: clean-doc
-	rm -rf .sphinx/venv
 	rm -rf reference/commands
+	rm -rf sphinx-resources/.sphinx/venv
 
 clean-doc:
 	git clean -fx "$(BUILDDIR)"
 
 spelling: html
-	. $(VENV) ; python3 -m pyspelling -c .sphinx/spellingcheck.yaml
+	. $(VENV) ; python3 -m pyspelling -c sphinx-resources/.sphinx/spellingcheck.yaml
+
+linkcheck:
+	. $(VENV) ; $(SPHINXBUILD) -c . -b linkcheck  "$(SOURCEDIR)" "$(BUILDDIR)"
+
+woke:
+	type woke >/dev/null 2>&1 || { snap install woke; exit 1; }
+	woke *.rst **/*.rst -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml
 
 .PHONY: help Makefile