Issue 014: Change theme to Read the Docs Sphinx Theme

Theme update to sphinx-rtd-theme as agreed at the Documentation
IRC meeting on 4 June 2020. Includes changes so that .gitlab-ci.yml
uses the latest version of the theme.

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index b08f816..cda6e88 100644 (file)
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -26,7 +26,8 @@ production:
         - build/en/html
     stage: deploy
     script:
-    - DEBIAN_FRONTEND=noninteractive apt-get install -y python3-sphinx  python3-sphinxcontrib.spelling python3-stemmer make rsync
+    - DEBIAN_FRONTEND=noninteractive apt-get install -y python3-sphinx  python3-sphinxcontrib.spelling python3-stemmer python3-pip make rsync
+    - pip3 install sphinx_rtd_theme
     - make all_epub # build/LANG/epub
     - make all_html # build/LANG/html
     - rsync -c -u -r -e "ssh" --progress build/* chrisc@www.koha-community.org:/var/www/manual/20.11/

diff --git a/source/conf.py b/source/conf.py
index f3d2226..422742c 100644 (file)
--- a/source/conf.py
+++ b/source/conf.py
@@ -19,6 +19,7 @@
 #
 # import os
 import sys; sys.setrecursionlimit(3000)
+import sphinx_rtd_theme
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
@@ -38,6 +39,7 @@ extensions = [
     'sphinx.ext.coverage',
     'sphinxcontrib.spelling',
     'sphinx.ext.autosectionlabel',
+    'sphinx_rtd_theme',
 ]
 
 # Spelling options
@@ -70,9 +72,9 @@ author = 'Koha Community'
 # built documents.
 #
 # The short X.Y version.
-version = '20.05'
+version = '20.11'
 # The full version, including alpha/beta/rc tags.
-release = '20.05'
+release = '20.11'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -132,13 +134,18 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # 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 = {
+
+    'prev_next_buttons_location': 'both',
+    'style_nav_header_background': '#4a9b32'
+
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []