Permalink
Browse files

Use sphinxcontrib.fulltoc and small doc updates

  • Loading branch information...
1 parent fb68a07 commit f13050a9a1d19537a43fe7ec26e85e8930162968 @nkuttler nkuttler committed Feb 17, 2013
Showing with 19 additions and 20 deletions.
  1. +1 −0 doc/conf.py
  2. +18 −20 doc/index.rst
View
@@ -28,6 +28,7 @@
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
+ 'sphinxcontrib.fulltoc',
]
intersphinx_mapping = {
View
@@ -3,31 +3,13 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-====================================
-Welcome to piwikapi's documentation!
-====================================
+About
+=====
.. image:: pic/piwik_logo.jpg
:alt: Piwik
:align: right
-Contents:
-
-.. toctree::
- :maxdepth: 3
-
- install
- tracking_usage
- tracking_reference
- analytics_usage
- analytics_reference
- plugins_reference
- hacking
- hacking_reference
- changelog
-
-About
-=====
``piwikapi`` is a Python implementation of the Piwik tracking and the
analytics API. You can use it to track visitors, ecommerce, actions, goals,
generate reports and much more.
@@ -130,6 +112,10 @@ out the code from the old repository.
Todo
====
+- Abstraction for various request models (Django, webob, ...?)
+- API rewrite
+- CLI client (?)
+
Supported
---------
- Normal tracking
@@ -151,6 +137,18 @@ Indices and tables
* :ref:`modindex`
* :ref:`search`
+.. toctree::
+
+ install
+ tracking_usage
+ tracking_reference
+ analytics_usage
+ analytics_reference
+ plugins_reference
+ hacking
+ hacking_reference
+ changelog
+
..
TODO What happens if we have one client-side request followed only by
server-side requests? Is the info tied to the user/visit?

0 comments on commit f13050a

Please sign in to comment.