]> kaliko git repositories - mpd-sima.git/commitdiff
Merged meta and track, switched to classic theme
authorkaliko <kaliko@azylum.org>
Wed, 11 Nov 2015 22:23:43 +0000 (23:23 +0100)
committerkaliko <kaliko@azylum.org>
Mon, 22 Nov 2021 15:01:30 +0000 (16:01 +0100)
doc/source/conf.py
doc/source/meta.rst
doc/source/track.rst [deleted file]

index 4bbcf8a6585e5ba2212285fd68412e9e2ce030d8..ab853056a2a561cbe5225ff1b1ca457123a84df8 100644 (file)
@@ -17,11 +17,13 @@ import sys
 import os
 import shlex
 
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.abspath('../../'))
+from sima.info import __version__
 
 # -- General configuration ------------------------------------------------
 
@@ -60,9 +62,9 @@ author = 'kaliko'
 # built documents.
 #
 # The short X.Y version.
-version = '0.14'
+version = __version__
 # The full version, including alpha/beta/rc tags.
-release = '0.14'
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -114,6 +116,7 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = 'alabaster'
+html_theme = 'classic'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
index 39b629f56bec2c5827909055edca06ceb9e9c871..906a30091854b31b78e16765b34af4a42642fcbc 100644 (file)
@@ -1,6 +1,29 @@
+Track object Documentation
+==========================
+
+.. automodule:: sima.lib.track
+    :members:
+
 Meta object Documentation
 =========================
 
-.. automodule:: sima.lib.meta
-    :members: Meta, Artist
+Generic class and helper function
+---------------------------------
+
+.. autoclass:: sima.lib.meta.Meta(name, mbid=None, **kwargs)
+    :members:
+    :undoc-members:
+
+.. autofunction:: sima.lib.meta.is_uuid4
+
+Derived objects
+---------------
+
+.. autoclass:: sima.lib.meta.Artist(name, mbid=None, albumartist=None, musicbrainz_artistid=None, musicbrainz_albumartistid=None)
+    :show-inheritance:
+
+
+Exceptions
+----------
 
+.. autoclass:: sima.lib.meta.MetaException
diff --git a/doc/source/track.rst b/doc/source/track.rst
deleted file mode 100644 (file)
index 957a4f9..0000000
+++ /dev/null
@@ -1,5 +0,0 @@
-Track object Documentation
-==========================
-
-.. automodule:: sima.lib.track
-    :members: