Define meta-data, define theme

.github/workflows/run.yml

@@ -42,7 +42,7 @@ jobs:
           pipenv install -r requirements.txt
 
       - name: Build main website
-        run: pipenv run sphinx-build doc build/html
+        run: ./run.sh
 
       - name: Upload website to artifacts
         uses: actions/upload-pages-artifact@v1

.gitignore

@@ -1,3 +1,4 @@
 .venv/
 Pipfile
+Pipfile.lock
 build/

doc/conf.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+"""Sphinx configuration file."""
+
+from setuptools_scm import get_version
+
+# -- Project information -----------------------------------------------------
+# @see https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Basejumpa's Website"
+
+version = get_version(root='..', relative_to=__file__)
+release = version
+
+author = 'Alexander Mann-Wahrenberg'
+copyright = f"2012 .. 2023, {author}"
+
+
+# -- General configuration ---------------------------------------------------
+# @see https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+# @see https://www.sphinx-doc.org/en/master/development/tutorials/helloworld.html
+
+extensions = [
+    'sphinx.ext.githubpages',       # @see https://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html
+]
+
+exclude_patterns = [
+]
+
+
+# -- Options for HTML output with theme "sphinx_material" -------------------
+# @see https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+# @see https://bashtage.github.io/sphinx-material/customization.html
+
+html_title = f"Basejumpa {version}" 
+# html_logo  = 'path'
+
+# Hide hyper link which leeds to the source of page displayed
+html_show_sourcelink = False
+
+html_sidebars = {
+    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
+}
+
+html_theme = 'sphinx_material'
+
+html_theme_options = {
+    'nav_title'    : f"Basejumpa's website",
+    'base_url'     : 'https://basejumpa.github.io/',
+
+    'repo_url'     : 'https://github.com/basejumpa/basejumpa.github.io',
+    'repo_name'    : 'basejumpa.github.io',
+
+    'color_primary': 'light-blue',
+    'color_accent' : 'yellow',
+
+    'globaltoc_depth'        : 3,
+    'globaltoc_collapse'     : 'true',
+    'globaltoc_includehidden': 'true',
+}
+
+# -- Options for XXXXXXXXXXXXXXXXX ------------------------------------------
+# @see 
+
+#EOF

requirements.txt

@@ -1 +1,3 @@
 sphinx
+setuptools-scm
+sphinx-material

run.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+pipenv run sphinx-build doc build/html