summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-05-25 22:53:24 +0200
committerJohn Villalovos <john@sodarock.com>2022-01-04 16:23:02 -0800
commitee6b024347bf8a178be1a0998216f2a24c940cee (patch)
treebee6ec58359ef8c50f0e18cc07c0e2daf6cd8afd /docs/conf.py
parent158238779e4608e76138ae437acf80f3175d5580 (diff)
downloadgitlab-ee6b024347bf8a178be1a0998216f2a24c940cee.tar.gz
docs: switch to Furo and refresh introduction pages
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py23
1 files changed, 8 insertions, 15 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 2a1b292..a801953 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -17,12 +17,14 @@ from __future__ import unicode_literals
import os
import sys
+from datetime import datetime
sys.path.append("../")
sys.path.append(os.path.dirname(__file__))
import gitlab # noqa: E402. Needed purely for readthedocs' build
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
+year = datetime.now().year
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -57,11 +59,13 @@ source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
# source_encoding = 'utf-8-sig'
# The master toctree document.
-master_doc = "index"
+root_doc = "index"
# General information about the project.
project = "python-gitlab"
-copyright = "2013-2018, Gauvain Pocentek, Mika Mäenpää"
+copyright = (
+ f"2013-2018, Gauvain Pocentek, Mika Mäenpää.\n2018-{year}, python-gitlab team"
+)
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -101,9 +105,6 @@ exclude_patterns = ["_build"]
# output. They are ignored by default.
# show_authors = False
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
-
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
@@ -115,15 +116,7 @@ pygments_style = "sphinx"
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = "default"
-if not on_rtd: # only import and set the theme if we're building docs locally
- try:
- import sphinx_rtd_theme
-
- html_theme = "sphinx_rtd_theme"
- html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
- except ImportError: # Theme not found, use default
- pass
+html_theme = "furo"
# 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
@@ -135,7 +128,7 @@ if not on_rtd: # only import and set the theme if we're building docs locally
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
-# html_title = None
+html_title = f"{project} <small>v{release}</small>"
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None