Upload the initial documentation for the archiver application

doc/conf/conf.py

@@ -26,7 +26,13 @@ sys.path.insert(0, os.path.abspath('../..')) # Django project root
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.todo']
+
+# Enable TODO support
+todo_include_todos = True
+
+# Document class members in source order
+autodoc_member_order = 'bysource'
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

doc/docs/archiver.models.rst

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

doc/docs/archiver.rst

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

doc/docs/modules.rst

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