From 80a289f694f092b50d511db39976ebc5c1f58fbf Mon Sep 17 00:00:00 2001 From: kaliko Date: Sat, 14 Nov 2015 17:58:00 +0100 Subject: [PATCH] Add cache/echonest to sphinx doc. --- doc/source/cache.rst | 7 +++++++ doc/source/echonest.rst | 6 ++++++ doc/source/index.rst | 14 ++++++++++++-- doc/source/lastfm.rst | 4 ++-- 4 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 doc/source/cache.rst create mode 100644 doc/source/echonest.rst diff --git a/doc/source/cache.rst b/doc/source/cache.rst new file mode 100644 index 0000000..350b52a --- /dev/null +++ b/doc/source/cache.rst @@ -0,0 +1,7 @@ +HTTP Cache Objects +================== + +.. automodule:: sima.lib.cache + :members: BaseCache, DictCache, FileCache + :undoc-members: + diff --git a/doc/source/echonest.rst b/doc/source/echonest.rst new file mode 100644 index 0000000..e5d2a91 --- /dev/null +++ b/doc/source/echonest.rst @@ -0,0 +1,6 @@ +EchoNest HTTP Client +==================== + +.. automodule:: sima.lib.simaecho + :members: SimaEch + diff --git a/doc/source/index.rst b/doc/source/index.rst index ea57936..fb96b7c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,14 +3,24 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to MPD_sima's documentation! -==================================== +MPD_sima's documentation! +========================= + + +Development documentation +------------------------- Contents: .. toctree:: :maxdepth: 2 + meta + lastfm + echonest + cache + + Indices and tables diff --git a/doc/source/lastfm.rst b/doc/source/lastfm.rst index 061ede1..464c940 100644 --- a/doc/source/lastfm.rst +++ b/doc/source/lastfm.rst @@ -1,5 +1,5 @@ -Last.fm Documentation -====================== +Last.fm HTTP Client +==================== .. automodule:: sima.lib.simafm :members: SimaFM -- 2.39.2