1 # Configuration file for the Sphinx documentation builder.
3 # For the full list of built-in configuration values, see the documentation:
4 # https://www.sphinx-doc.org/en/master/usage/configuration.html
6 # -- Project information -----------------------------------------------------
7 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
11 sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix())
12 from mpdaio.const import VERSION
14 project = 'musicpdaio'
15 copyright = '2024, kaliko'
21 # -- General configuration ---------------------------------------------------
22 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
26 'sphinx.ext.intersphinx',
27 'sphinx.ext.viewcode',
31 templates_path = ['_templates']
34 # -- Options for HTML output -------------------------------------------------
35 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
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',
49 .. _asyncio: https://docs.python.org/3/library/asyncio.html
50 .. _Diátaxis: https://diataxis.fr/
51 .. _codeberg forge: https://codeberg.org/MusicPlayerDaemon/python-musicpdaio
52 .. _MPD protocol documentation: http://www.musicpd.org/doc/protocol/
53 .. _Music Player Daemon: http://www.musicpd.org/
54 .. _python-musicpd: https://kaliko.gitlab.io/python-musicpd
55 .. _Semantic Versioning: https://semver.org/spec/v2.0.0.html
56 .. _snake case: https://en.wikipedia.org/wiki/Snake_case
57 .. |mpdaio.MPDClient| replace:: :py:class:`mpdaio.MPDClient<mpdaio.client.MPDClient>`
60 autodoc_typehints = 'description'
61 autodoc_member_order = 'bysource'
63 # -- Options for intersphinx extension ---------------------------------------
64 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration
66 intersphinx_mapping = {
67 'python': ('https://docs.python.org/3', None),