Improved documentation

[python-musicpdaio.git] / doc / source / conf.py

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 6377b0398a6e9dc7f647bc16363488cf16428aba..c0f2a053d6f7b571ca0b14df5f919b60e60e0b0e 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -5,11 +5,18 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../../'))
+from mpdaio.const import VERSION
 
 project = 'musicpdaio'
 copyright = '2024, kaliko'
 author = 'kaliko'
-release = '0.0.1'
+
+version = VERSION
+release = VERSION
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -29,11 +36,24 @@ exclude_patterns = []
 
 html_theme = 'alabaster'
 html_static_path = ['_static']
+html_baseurl= 'https://musicplayerdaemon.codeberg.page/python-musicpdaio/'
 html_theme_options = {
     'page_width' : '1024px',
     'fixed_sidebar': 'true',
+    'base_bg': '#eee',
+    'pre_bg': '#fff',
     }
 
+rst_epilog = """
+.. _asyncio: https://docs.python.org/3/library/asyncio.html
+.. _Diátaxis: https://diataxis.fr/
+.. _MPD protocol documentation: http://www.musicpd.org/doc/protocol/
+.. _python-musicpd: https://kaliko.gitlab.io/python-musicpd
+.. _Semantic Versioning: https://semver.org/spec/v2.0.0.html
+.. _snake case: https://en.wikipedia.org/wiki/Snake_case
+
+"""
+
 # -- Options for intersphinx extension ---------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration