diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2012-01-14 16:31:53 +0000 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-01-14 16:31:53 +0000 |
commit | 8e1feacc0d6de27bf627a418f8cfc572c4562d40 (patch) | |
tree | 2ee023a1be12fe5d757c1f34aa4601c6fb956a7e | |
parent | 96ebafec4a5134f3a0efacb5db8f392a0799c886 (diff) |
moved api docs, updated README
-rw-r--r-- | README.md | 6 | ||||
-rw-r--r-- | docs/dev/Makefile (renamed from docs/api/Makefile) | 0 | ||||
-rw-r--r-- | docs/dev/source/accounts.rst (renamed from docs/api/source/accounts.rst) | 0 | ||||
-rw-r--r-- | docs/dev/source/commands.rst (renamed from docs/api/source/commands.rst) | 0 | ||||
-rw-r--r-- | docs/dev/source/conf.py (renamed from docs/api/source/conf.py) | 0 | ||||
-rw-r--r-- | docs/dev/source/database.rst (renamed from docs/api/source/database.rst) | 0 | ||||
-rw-r--r-- | docs/dev/source/index.rst (renamed from docs/api/source/index.rst) | 0 | ||||
-rw-r--r-- | docs/dev/source/interface.rst (renamed from docs/api/source/interface.rst) | 0 | ||||
-rw-r--r-- | docs/dev/source/settings.rst (renamed from docs/api/source/settings.rst) | 0 | ||||
-rw-r--r-- | docs/dev/source/utils.rst (renamed from docs/api/source/utils.rst) | 0 |
10 files changed, 4 insertions, 2 deletions
@@ -2,10 +2,11 @@ Alot is an experimantal terminal MUA based on [notmuch mail][notmuch]. It is written in python using the [urwid][urwid] toolkit. See `INSTALL.md` for instructions on how to set it up and have a look -at the user manual in `docs/user` for advanced usage and cusomization. +at the [user manual][userdocs] (sources in in `docs/user`) +for advanced usage and customization. Development happens in branch 'testing', autogenerated API docs for the -current HEAD can be found [here][api]. Their sources live in `docs/api`. +current HEAD can be found [here][api]. Their sources live in `docs/dev`. Do comment on the code or file issues! I'm curious what you think of it. You can talk to me in #notmuch@Freenode. @@ -50,4 +51,5 @@ The key bindings for the current mode are listed upon pressing `?`. [notmuch]: http://notmuchmail.org/ [urwid]: http://excess.org/urwid/ [api]: http://alot.rtfd.org +[userdocs]: http://pazz.github.com/alot/ [wiki]: https://github.com/pazz/alot/wiki diff --git a/docs/api/Makefile b/docs/dev/Makefile index b4d9a3dd..b4d9a3dd 100644 --- a/docs/api/Makefile +++ b/docs/dev/Makefile diff --git a/docs/api/source/accounts.rst b/docs/dev/source/accounts.rst index c09b43fa..c09b43fa 100644 --- a/docs/api/source/accounts.rst +++ b/docs/dev/source/accounts.rst diff --git a/docs/api/source/commands.rst b/docs/dev/source/commands.rst index f38ac04c..f38ac04c 100644 --- a/docs/api/source/commands.rst +++ b/docs/dev/source/commands.rst diff --git a/docs/api/source/conf.py b/docs/dev/source/conf.py index 0c36a73f..0c36a73f 100644 --- a/docs/api/source/conf.py +++ b/docs/dev/source/conf.py diff --git a/docs/api/source/database.rst b/docs/dev/source/database.rst index 00334a4b..00334a4b 100644 --- a/docs/api/source/database.rst +++ b/docs/dev/source/database.rst diff --git a/docs/api/source/index.rst b/docs/dev/source/index.rst index f9e0cf15..f9e0cf15 100644 --- a/docs/api/source/index.rst +++ b/docs/dev/source/index.rst diff --git a/docs/api/source/interface.rst b/docs/dev/source/interface.rst index 75b7d5c3..75b7d5c3 100644 --- a/docs/api/source/interface.rst +++ b/docs/dev/source/interface.rst diff --git a/docs/api/source/settings.rst b/docs/dev/source/settings.rst index f7272756..f7272756 100644 --- a/docs/api/source/settings.rst +++ b/docs/dev/source/settings.rst diff --git a/docs/api/source/utils.rst b/docs/dev/source/utils.rst index 8cfae2b7..8cfae2b7 100644 --- a/docs/api/source/utils.rst +++ b/docs/dev/source/utils.rst |