From ab39735723585eb158fb873b24b200f81f90f533 Mon Sep 17 00:00:00 2001
From: Dominik George <dominik.george@teckids.org>
Date: Mon, 10 Jan 2022 17:51:25 +0100
Subject: [PATCH] [Docs] Use Sphinx material theme
---
docs/conf.py | 20 +++++++++++++++++---
pyproject.toml | 2 +-
2 files changed, 18 insertions(+), 4 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index bf2e67851..3f5eca766 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -84,13 +84,25 @@ pygments_style = None
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = "sphinx_materialdesign_theme"
+html_theme = "sphinx_material"
+
+html_favicon = "../aleksis/core/static/img/aleksis-icon.png"
+html_logo = "../aleksis/core/static/img/aleksis-banner.svg"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
-# html_theme_options = {}
+html_theme_options = {
+ "repo_url": f"https://edugit.org/AlekSIS/official/{project}",
+ "repo_name": "EduGit",
+ "repo_type": "gitlab",
+ "theme_color": "#0d5eaf",
+ "color_primary": "#0d5eaf",
+ "color_accent": "#0d5eaf",
+ "globaltoc_depth": 2,
+ "globaltoc_collapse": False,
+}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@@ -105,7 +117,9 @@ html_static_path = ["_static"]
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
-# html_sidebars = {}
+html_sidebars = {
+ "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
+}
# -- Options for HTMLHelp output ---------------------------------------------
diff --git a/pyproject.toml b/pyproject.toml
index c61126247..41cef702c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -133,7 +133,7 @@ s3 = ["boto3", "django-storages"]
sentry = ["sentry-sdk"]
[tool.poetry.dev-dependencies]
-aleksis-builddeps = "^5"
+aleksis-builddeps = "^6"
uwsgi = "^2.0"
[tool.poetry.scripts]
--
GitLab