X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fsource%2Fconf.py;h=d59ac2ac894fcef588c5e7a479fa1030c7750422;hb=refs%2Fheads%2Fmain;hp=c0f2a053d6f7b571ca0b14df5f919b60e60e0b0e;hpb=baa907b0e0378dd0ed09f6e1202f5ed605f3f344;p=python-musicpdaio.git diff --git a/doc/source/conf.py b/doc/source/conf.py index c0f2a05..d59ac2a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -5,10 +5,10 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -import os +import pathlib import sys -sys.path.insert(0, os.path.abspath('../../')) +sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix()) from mpdaio.const import VERSION project = 'musicpdaio' @@ -42,18 +42,24 @@ html_theme_options = { '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