Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-01-05 15:33:15 +01:00
Code Issues Projects Releases Wiki Activity

skeletal autodoc-based API docs

Browse source
This commit is contained in:
Adrian Sampson 2013-09-24 20:57:24 -07:00
parent e6725b6973
commit a6bf633355
2 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/conf.py
View file

@ -2,7 +2,7 @@ AUTHOR = u'Adrian Sampson'
# -- General configuration -----------------------------------------------------
extensions = []
extensions = ['sphinx.ext.autodoc']
#templates_path = ['_templates']
exclude_patterns = ['_build']

23
docs/dev/api.rst
View file

@ -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: