From 3e8047001f033e9d3284ee800e1ab8259693ed2e Mon Sep 17 00:00:00 2001
From: Dominik George <dominik.george@teckids.org>
Date: Mon, 10 Jan 2022 12:06:07 +0100
Subject: [PATCH] [Docs] Generalise Sphinx config
---
docs/conf.py | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index ae443be4f..8ba336abc 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -24,14 +24,14 @@ django.setup()
# -- Project information -----------------------------------------------------
-project = "AlekSIS"
-copyright = "2019, 2020, AlekSIS team"
-author = "AlekSIS team"
+project = "AlekSIS-Core"
+copyright = "2019-2022 The AlekSIS team"
+author = "The AlekSIS Team"
# The short X.Y version
-version = "2.2"
+version = "2.5"
# The full version, including alpha/beta/rc tags
-release = "2.2"
+release = "2.5.1.dev0"
# -- General configuration ---------------------------------------------------
@@ -111,7 +111,7 @@ html_static_path = ["_static"]
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
-htmlhelp_basename = "AlekSISdoc"
+htmlhelp_basename = f"{project}doc"
# -- Options for LaTeX output ------------------------------------------------
@@ -135,7 +135,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, "AlekSIS.tex", "AlekSIS Documentation", "AlekSIS team", "manual"),
+ (master_doc, f"{project}.tex", f"{project} Documentation", author, "manual"),
]
@@ -143,7 +143,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "aleksis", "AlekSIS Documentation", [author], 1)]
+man_pages = [(master_doc, "aleksis", f"{project} Documentation", [author], 1)]
# -- Options for Texinfo output ----------------------------------------------
@@ -154,10 +154,10 @@ man_pages = [(master_doc, "aleksis", "AlekSIS Documentation", [author], 1)]
texinfo_documents = [
(
master_doc,
- "AlekSIS",
- "AlekSIS Documentation",
+ project,
+ f"{project} Documentation",
author,
- "AlekSIS",
+ project,
"One line description of project.",
"Miscellaneous",
),
--
GitLab