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
   9 project = 'musicpdaio'
  10 copyright = '2024, kaliko'
  11 author = 'kaliko'
  12 release = '0.0.1'
  13
  14 # -- General configuration ---------------------------------------------------
  15 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
  16
  17 extensions = [
  18     'sphinx.ext.autodoc',
  19     'sphinx.ext.intersphinx',
  20     'sphinx.ext.viewcode',
  21     'sphinx.ext.todo',
  22 ]
  23
  24 templates_path = ['_templates']
  25 exclude_patterns = []
  26
  27 # -- Options for HTML output -------------------------------------------------
  28 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
  29
  30 html_theme = 'alabaster'
  31 html_static_path = ['_static']
  32 html_theme_options = {
  33     'page_width' : '1024px',
  34     'fixed_sidebar': 'true',
  35     }
  36
  37 # -- Options for intersphinx extension ---------------------------------------
  38 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration
  39
  40 intersphinx_mapping = {
  41     'python': ('https://docs.python.org/3', None),
  42 }