refactor: removes files now provided in canonical-sphinx==0.3.0 (#318)

* fix: moves gitignore to root * feat: removes latex config after canonical-sphinx version change * fix: use pypi version of canonical-sphinx * fix: removes font files as they are included in canonical-sphinx 0.3.0 * fix: removes static and template files as they are included in canonical-sphinx 0.3.0 * fix: remove PDF configuration as it is now included in canonical-sphinx==0.3.0 * fix: add Pillow build requirements for source build check
canonical · Jan 6, 2025 · 8bef847 · 8bef847
1 parent 898410d
commit 8bef847
Show file tree

Hide file tree

Showing 21 changed files with 31 additions and 337 deletions.
diff --git a/.github/workflows/sphinx-python-dependency-build-checks.yml b/.github/workflows/sphinx-python-dependency-build-checks.yml
@@ -37,7 +37,8 @@ jobs:
           libxslt1-dev \
           make \
           python3-venv \
-          rustc
+          rustc \
+          libtiff5-dev libjpeg8-dev libopenjp2-7-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.6-dev tk8.6-dev python3-tk libharfbuzz-dev libfribidi-dev libxcb1-dev
     - name: Build Sphinx venv
       working-directory: "docs"
       run: |

diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,28 @@
+
+# Starter pack rules start here
+
+# Environment
+/*env*/
+docs/.sphinx/venv/
+
+# Sphinx
+docs/.sphinx/warnings.txt
+docs/.sphinx/.wordlist.dic
+docs/.sphinx/.doctrees/
+docs/.sphinx/node_modules/
+
+# Vale
+docs/.sphinx/styles/*
+docs/.sphinx/vale.ini
+
+# Build outputs
+docs/_build
+
+# Node.js
+docs/package*.json
+
+# Unrelated cache and config files
+docs/.DS_Store
+docs/__pycache__
+docs/.idea/
+docs/.vscode/
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/.sphinx/_static/css/pdf.css b/docs/.sphinx/_static/css/pdf.css
diff --git a/docs/.sphinx/_static/favicon.png b/docs/.sphinx/_static/favicon.png
diff --git a/docs/.sphinx/_static/project_specific.css b/docs/.sphinx/_static/project_specific.css
diff --git a/docs/.sphinx/_static/tag.png b/docs/.sphinx/_static/tag.png
diff --git a/docs/.sphinx/_templates/header.html b/docs/.sphinx/_templates/header.html
diff --git a/docs/.sphinx/fonts/LICENCE.txt b/docs/.sphinx/fonts/LICENCE.txt
diff --git a/docs/.sphinx/fonts/Ubuntu-B.ttf b/docs/.sphinx/fonts/Ubuntu-B.ttf
diff --git a/docs/.sphinx/fonts/Ubuntu-R.ttf b/docs/.sphinx/fonts/Ubuntu-R.ttf
diff --git a/docs/.sphinx/fonts/Ubuntu-RI.ttf b/docs/.sphinx/fonts/Ubuntu-RI.ttf
diff --git a/docs/.sphinx/fonts/UbuntuMono-B.ttf b/docs/.sphinx/fonts/UbuntuMono-B.ttf
diff --git a/docs/.sphinx/fonts/UbuntuMono-R.ttf b/docs/.sphinx/fonts/UbuntuMono-R.ttf
diff --git a/docs/.sphinx/fonts/UbuntuMono-RI.ttf b/docs/.sphinx/fonts/UbuntuMono-RI.ttf
diff --git a/docs/.sphinx/images/Canonical-logo-4x.png b/docs/.sphinx/images/Canonical-logo-4x.png
diff --git a/docs/.sphinx/images/front-page-light.pdf b/docs/.sphinx/images/front-page-light.pdf
diff --git a/docs/.sphinx/images/normal-page-footer.pdf b/docs/.sphinx/images/normal-page-footer.pdf
diff --git a/docs/.sphinx/latex_elements_template.txt b/docs/.sphinx/latex_elements_template.txt
diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt
@@ -1,4 +1,4 @@
-canonical-sphinx[full] @ git+https://github.com/canonical/canonical-sphinx@main
+canonical-sphinx[full]
 sphinx-autobuild
 sphinxcontrib-svg2pdfconverter[CairoSVG]
 sphinx-last-updated-by-git
diff --git a/docs/conf.py b/docs/conf.py
@@ -290,28 +290,3 @@
 
 if "discourse_prefix" not in html_context and "discourse" in html_context:
     html_context["discourse_prefix"] = html_context["discourse"] + "/t/"
-
-#####################
-# PDF configuration #
-#####################
-
-latex_additional_files = [
-    "./.sphinx/fonts/Ubuntu-B.ttf",
-    "./.sphinx/fonts/Ubuntu-R.ttf",
-    "./.sphinx/fonts/Ubuntu-RI.ttf",
-    "./.sphinx/fonts/UbuntuMono-R.ttf",
-    "./.sphinx/fonts/UbuntuMono-RI.ttf",
-    "./.sphinx/fonts/UbuntuMono-B.ttf",
-    "./.sphinx/images/Canonical-logo-4x.png",
-    "./.sphinx/images/front-page-light.pdf",
-    "./.sphinx/images/normal-page-footer.pdf",
-]
-
-latex_engine = "xelatex"
-latex_show_pagerefs = True
-latex_show_urls = "footnote"
-
-with open(".sphinx/latex_elements_template.txt", "rt") as file:
-    latex_config = file.read()
-
-latex_elements = ast.literal_eval(latex_config.replace("$PROJECT", project))