X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fsource%2Fconf.py;h=d59ac2ac894fcef588c5e7a479fa1030c7750422;hb=refs%2Fheads%2Fmain;hp=6377b0398a6e9dc7f647bc16363488cf16428aba;hpb=cdf2dd0c1021639a4aebae4eac44fbb09a224877;p=python-musicpdaio.git diff --git a/doc/source/conf.py b/doc/source/conf.py index 6377b03..d59ac2a 100644 --- 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 pathlib +import sys + +sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix()) +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,30 @@ 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', + 'note_bg': '#fff', } +rst_epilog = """ +.. _asyncio: https://docs.python.org/3/library/asyncio.html +.. _Diátaxis: https://diataxis.fr/ +.. _codeberg forge: https://codeberg.org/MusicPlayerDaemon/python-musicpdaio +.. _MPD protocol documentation: http://www.musicpd.org/doc/protocol/ +.. _Music Player Daemon: http://www.musicpd.org/ +.. _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 +.. |mpdaio.MPDClient| replace:: :py:class:`mpdaio.MPDClient` +""" + +autodoc_typehints = 'description' +autodoc_member_order = 'bysource' + # -- Options for intersphinx extension --------------------------------------- # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration