Document your API
=================

Web services without a proper documentation are usually useless.

The recommended way is to use the tgwsdoc Sphinx extension, which lies
in the "contrib" directory.

If you don't have the source distribution of TGWebServices, you can fetch
the files from http://tgws.googlecode.com/hg/contrib/tgwsdoc/.

.. automodule:: tgwsdoc

Example
-------

Given the following program :

.. literalinclude:: ../contrib/tgwsdoc/example/api.py
    :language: python
    :linenos:

The documentation source would be :

.. literalinclude:: ../contrib/tgwsdoc/example/doc.rst
    :language: rest
    :linenos:

And the result :

.. toctree::

    documentingexample