]> kaliko git repositories - python-musicpdaio.git/blobdiff - doc/source/conf.py
Add more docstrings
[python-musicpdaio.git] / doc / source / conf.py
index c0f2a053d6f7b571ca0b14df5f919b60e60e0b0e..94bd369b9755f4c45b4e77ecf0c64b9ec5b732b2 100644 (file)
@@ -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'
@@ -51,9 +51,12 @@ rst_epilog = """
 .. _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<mpdaio.client.MPDClient>`
 """
 
+autodoc_typehints = 'description'
+autodoc_member_order = 'bysource'
+
 # -- Options for intersphinx extension ---------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration