Take our own docs style advice.

README.rst

@@ -1,3 +1,4 @@
+=====================================
 Spinneret: Twisted Web's Silk Spinner
 =====================================
 
@@ -23,7 +24,7 @@ See http://github.com/jonathanj/txspinneret for development.
 
 
 Installation
-------------
+============
 
 .. code-block:: console
 

docs/api.rst

@@ -1,8 +1,9 @@
+=================
 API Documentation
 =================
 
 Resource routing
-----------------
+================
 
 .. automodule:: txspinneret.route
    :members:
@@ -14,7 +15,7 @@ Resource routing
 
 
 Query arguments
----------------
+===============
 
 .. automodule:: txspinneret.query
    :members:
@@ -26,7 +27,7 @@ Query arguments
 
 
 Utility resources
------------------
+=================
 
 .. automodule:: txspinneret.resource
    :members:
@@ -37,7 +38,7 @@ Utility resources
 
 
 Interfaces
-----------
+==========
 
 .. automodule:: txspinneret.interfaces
    :members:

docs/index.rst

@@ -3,14 +3,15 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+=====================================
 Spinneret: Twisted Web's Silk Spinner
 =====================================
 
 Release v\ |release|.
 
 
 What is this?
--------------
+=============
 
 Spinneret is a collection of higher-level utility classes and functions to make
 writing complex Twisted Web applications far simpler, it is designed to easily
@@ -19,7 +20,7 @@ integrate with existing Twisted Web projects for things like the improved
 
 
 Why is this one different?
---------------------------
+==========================
 
 While I think `Klein`_ is a fantastic library—and a terrific source of
 inspiration—there are some fundamental aspects I disagree with, not to mention
@@ -46,7 +47,7 @@ Or to install the latest development version:
 
 
 Documentation
--------------
+=============
 
 .. toctree::
    :maxdepth: 2
@@ -63,10 +64,11 @@ API documentation
 
    api
 
-Indices and tables
-==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+Contributing
+============
+
+.. toctree::
+   :maxdepth: 2
 
+   contributing

docs/query.rst

@@ -1,5 +1,6 @@
 .. py:currentmodule:: txspinneret.query
 
+===============
 Query Arguments
 ===============
 
@@ -12,7 +13,7 @@ The tedious process of processing query arguments usually follows this pattern:
 
 
 Parsing query arguments
------------------------
+=======================
 
 This small set of utility functions can relieve some of that pain, for example
 assume the query string is

docs/resource.rst

@@ -1,5 +1,6 @@
 .. py:currentmodule:: txspinneret.resource
 
+==================
 Resource Utilities
 ==================
 
@@ -8,7 +9,7 @@ with any existing `IResource` implementations.
 
 
 More featureful resources
--------------------------
+=========================
 
 `ISpinneretResource` is cut-down version of `IResource` that allows child
 location (via `ISpinneretResource.locateChild`) and rendering (via the normal
@@ -27,7 +28,7 @@ And secondly, a `list` of remaining path segments to be processed.
 
 
 Negotiating resources based on ``Accept``
------------------------------------------
+=========================================
 
 When building an API, in particular, you may want to negotiate the resource
 that best fits what the client is willing to accept, as specified in the

docs/route.rst

@@ -1,5 +1,6 @@
 .. py:currentmodule:: txspinneret.route
 
+===========
 URL Routing
 ===========
 
@@ -17,7 +18,7 @@ is only possible to specify relative routes.
 
 
 Router basics
--------------
+=============
 
 `Router.route` will match a URL route exactly, meaning that every route
 component must match the respective segment in the URL path; eg.
@@ -42,7 +43,7 @@ other parts of Spinneret or Twisted Web.
 
 
 Special routes
---------------
+==============
 
 There are two routes—particularly in the case of nested routers—that may not be
 obvious at first: The null root and the empty route.
@@ -70,7 +71,7 @@ with ``@router.route()`` (the null route.)
 
 
 Matcher basics
---------------
+==============
 
 `txspinneret.route` contains some basic matchers such as `Any` (which is
 a synonym for `Text`) and `Integer`. These matchers are simple factory
@@ -81,7 +82,7 @@ match.) Writing your own matchers to suit your needs is encouraged.
 
 
 An example router
------------------
+=================
 
 .. literalinclude:: examples/user_router.py