From a6bf63335578cec90852aaacf574ffcc43974618 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Tue, 24 Sep 2013 20:57:24 -0700 Subject: [PATCH] skeletal autodoc-based API docs --- docs/conf.py | 2 +- docs/dev/api.rst | 23 ++++++++++++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index dba10592b..9ac34cb3b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,7 @@ AUTHOR = u'Adrian Sampson' # -- General configuration ----------------------------------------------------- -extensions = [] +extensions = ['sphinx.ext.autodoc'] #templates_path = ['_templates'] exclude_patterns = ['_build'] diff --git a/docs/dev/api.rst b/docs/dev/api.rst index 7747cbb67..e7da2b4bd 100644 --- a/docs/dev/api.rst +++ b/docs/dev/api.rst @@ -1,4 +1,25 @@ API Documentation ================= -TK. +.. currentmodule:: beets.library + +The Library Class +----------------- + +.. autoclass:: Library(path, directory[, path_formats[, replacements]]) + :members: + +Model Classes +------------- + +.. autoclass:: FlexModel + :members: + +.. autoclass:: LibModel + :members: + +.. autoclass:: Item + :members: + +.. autoclass:: Album + :members: