doc/source/conf.py

   1 # Configuration file for the Sphinx documentation builder.
   2 #
   3 # For the full list of built-in configuration values, see the documentation:
   4 # https://www.sphinx-doc.org/en/master/usage/configuration.html
   5
   6 # -- Project information -----------------------------------------------------
   7 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
   8 import pathlib
   9 import sys
  10
  11 sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix())
  12 from mpdaio.const import VERSION
  13
  14 project = 'musicpdaio'
  15 copyright = '2024, kaliko'
  16 author = 'kaliko'
  17
  18 version = VERSION
  19 release = VERSION
  20
  21 # -- General configuration ---------------------------------------------------
  22 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
  23
  24 extensions = [
  25     'sphinx.ext.autodoc',
  26     'sphinx.ext.intersphinx',
  27     'sphinx.ext.viewcode',
  28     'sphinx.ext.todo',
  29 ]
  30
  31 templates_path = ['_templates']
  32 exclude_patterns = []
  33
  34 # -- Options for HTML output -------------------------------------------------
  35 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
  36
  37 html_theme = 'alabaster'
  38 html_static_path = ['_static']
  39 html_baseurl= 'https://musicplayerdaemon.codeberg.page/python-musicpdaio/'
  40 html_theme_options = {
  41     'page_width' : '1024px',
  42     'fixed_sidebar': 'true',
  43     'base_bg': '#eee',
  44     'pre_bg': '#fff',
  45     'note_bg': '#fff',
  46     }
  47
  48 rst_epilog = """
  49 .. _asyncio: https://docs.python.org/3/library/asyncio.html
  50 .. _Diátaxis: https://diataxis.fr/
  51 .. _MPD protocol documentation: http://www.musicpd.org/doc/protocol/
  52 .. _python-musicpd: https://kaliko.gitlab.io/python-musicpd
  53 .. _Semantic Versioning: https://semver.org/spec/v2.0.0.html
  54 .. _snake case: https://en.wikipedia.org/wiki/Snake_case
  55 .. |mpdaio.MPDClient| replace:: :py:class:`mpdaio.MPDClient<mpdaio.client.MPDClient>`
  56 """
  57
  58 autodoc_typehints = 'description'
  59 autodoc_member_order = 'bysource'
  60
  61 # -- Options for intersphinx extension ---------------------------------------
  62 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration
  63
  64 intersphinx_mapping = {
  65     'python': ('https://docs.python.org/3', None),
  66 }