From 46cee49bf4453ae36f768a9f53421a5b85ad89a0 Mon Sep 17 00:00:00 2001 From: kaliko Date: Wed, 11 Nov 2015 23:23:43 +0100 Subject: [PATCH] Merged meta and track, switched to classic theme --- doc/source/conf.py | 7 +++++-- doc/source/meta.rst | 27 +++++++++++++++++++++++++-- doc/source/track.rst | 5 ----- 3 files changed, 30 insertions(+), 9 deletions(-) delete mode 100644 doc/source/track.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 4bbcf8a..ab85305 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 diff --git a/doc/source/meta.rst b/doc/source/meta.rst index 39b629f..906a300 100644 --- a/doc/source/meta.rst +++ b/doc/source/meta.rst @@ -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 index 957a4f9..0000000 --- a/doc/source/track.rst +++ /dev/null @@ -1,5 +0,0 @@ -Track object Documentation -========================== - -.. automodule:: sima.lib.track - :members: -- 2.39.5