From fb74ceaa1d9ea833f90d2112e9d5ef53062f7fb0 Mon Sep 17 00:00:00 2001 From: Bradlee Speice Date: Thu, 9 May 2013 18:38:15 -0400 Subject: [PATCH] Fix up initial documentation a bit. --- doc/docs/archiver.rst | 5 +++++ doc/extra/testing.rst | 5 ----- index.rst | 15 +++++---------- 3 files changed, 10 insertions(+), 15 deletions(-) create mode 100644 doc/docs/archiver.rst delete mode 100644 doc/extra/testing.rst diff --git a/doc/docs/archiver.rst b/doc/docs/archiver.rst new file mode 100644 index 0000000..13e564c --- /dev/null +++ b/doc/docs/archiver.rst @@ -0,0 +1,5 @@ +==== +Archive backend documentation +==== + +.. automodule:: archiver diff --git a/doc/extra/testing.rst b/doc/extra/testing.rst deleted file mode 100644 index 5eff760..0000000 --- a/doc/extra/testing.rst +++ /dev/null @@ -1,5 +0,0 @@ -==== -Extra documentation file -==== - -Place extra documentation here. diff --git a/index.rst b/index.rst index 0ec2ec9..2fcd967 100644 --- a/index.rst +++ b/index.rst @@ -3,19 +3,14 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Melodia's documentation! +Melodia documentation =================================== -Contents: +Welcome to the documentation for Melodia! + +Melodia is a full-featured music solution. It's designed to handle very large archives of music (the developer has 14,500+ songs), and multiple archive locations at that. The API documentation is below. .. toctree:: - :maxdepth: 2 :glob: - doc/extra/* - -.. automodule:: archiver - :members: - -.. automodule:: web - :members: + doc/docs/*