Update welcome page and module documentation

psss · Sep 11, 2015 · 5de5514 · 5de5514
1 parent 0773a3f
commit 5de5514
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/did/__init__.py b/did/__init__.py
@@ -1,4 +1,11 @@
 """
+What did you do last week, month, year?
+
+Comfortably gather status report data (e.g. list of committed
+changes) for given week, month, quarter, year or selected date
+range. By default all available stats for this week are reported.
+Detailed documentation available at http://did.readthedocs.org/.
+
 The `stats`_ module contains the core of the stats gathering
 functionality. Some basic functionality like exceptions, config,
 user and date handling is placed in the `base`_ module. Generic

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,14 +3,19 @@
     did
 =====================
 
-.. automodule:: did
-    :members:
+This is **did**, a command line tool which will help you to easily
+gather data for your weekly, monthly or yearly reports. It suports
+plugins for various data sources such as git, trac, wiki, bugzilla
+and more. It can be used to gather stats for a single user as well
+as for the whole team and merging them together. It saves you from
+that boring stuff of making notes and later putting them together.
+
 
 Table of Contents
 ==================
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
 
     Overview <overview>
     Install <install>
@@ -24,4 +29,3 @@ Indices and Tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`