more rtd test

jazzband · Jun 22, 2014 · 710c369 · 710c369
1 parent 1535225
commit 710c369
Show file tree

Hide file tree

Showing 13 changed files with 21 additions and 8 deletions.
diff --git a/docs/_static/1.png b/docs/_static/1.png
diff --git a/docs/_static/2.png b/docs/_static/2.png
diff --git a/docs/_static/3.png b/docs/_static/3.png
diff --git a/docs/_static/4.png b/docs/_static/4.png
diff --git a/docs/_static/5.png b/docs/_static/5.png
diff --git a/docs/_static/6.png b/docs/_static/6.png
diff --git a/docs/_static/7.png b/docs/_static/7.png
diff --git a/docs/_static/8.png b/docs/_static/8.png
diff --git a/docs/_static/9.png b/docs/_static/9.png
diff --git a/docs/_static/meta.png b/docs/_static/meta.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -227,7 +227,9 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'silk', u'silk Documentation',
-     [u'Michael Ford'], 1)
+     [u'Michael Ford'], 1),
+        ('profiling', 'Profiling', u'Profiling',
+     [u'Michael Ford'], 2),
 ]
 
 # If true, show URL addresses after external links.

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,20 +3,29 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to silk's documentation!
+Silk
 ================================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-Testing 1, 2, 3
+   profiling
 
-Indices and tables
-==================
+Silk is a live profiling and inspection tool for the Django framework. Silk can:
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+- Intercept HTTP requests and responses for further inspection
+- Time execution of requests
+- Intercept database queries per request
+- Profile blocks of code 
+	- Timing
+	- Database queries
 
+A live demo is available at http://mtford.co.uk/silk/.
+
+Requirements
+------------
+
+* Django: 1.5, 1.6
+* Python: 2.7, 3.3, 3.4
diff --git a/docs/profiling.rst b/docs/profiling.rst
@@ -0,0 +1,2 @@
+Profiling
+=========