1
0
mirror of https://github.com/bspeice/Melodia synced 2025-07-05 16:04:43 -04:00

Upload the initial documentation for the archiver application

This commit is contained in:
Bradlee Speice
2013-05-09 23:30:35 -04:00
parent a515a4b8d3
commit 441f57bb2b
10 changed files with 354 additions and 104 deletions

View File

@ -0,0 +1,39 @@
models Package
==============
:mod:`models` Package
---------------------
.. automodule:: archiver.models
:members:
:undoc-members:
:show-inheritance:
:mod:`archive` Module
---------------------
.. automodule:: archiver.models.archive
:members:
:show-inheritance:
:mod:`feed` Module
------------------
.. automodule:: archiver.models.feed
:members:
:show-inheritance:
:mod:`playlist` Module
----------------------
.. automodule:: archiver.models.playlist
:members:
:show-inheritance:
:mod:`song` Module
------------------
.. automodule:: archiver.models.song
:members:
:show-inheritance:

View File

@ -1,5 +1,42 @@
====
Archive backend documentation
====
archiver Package
================
:mod:`archiver` Package
-----------------------
.. automodule:: archiver.__init__
:members:
:undoc-members:
:show-inheritance:
:mod:`listfield` Module
-----------------------
.. automodule:: archiver.listfield
:members:
:undoc-members:
:show-inheritance:
:mod:`tests` Module
-------------------
.. automodule:: archiver.tests
:members:
:undoc-members:
:show-inheritance:
:mod:`views` Module
-------------------
.. automodule:: archiver.views
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
archiver.models
.. automodule:: archiver

7
doc/docs/modules.rst Normal file
View File

@ -0,0 +1,7 @@
archiver
========
.. toctree::
:maxdepth: 4
archiver