doc/api/index.rst

   1 .. gpodder.net documentation master file, created by
   2    sphinx-quickstart on Sat Mar  9 11:41:24 2013.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 API 3 Documentation (draft)
   7 ===========================
   8
   9 *This site contains drafts for the gpodder.net's future API -- version 3 --
  10 which is not yet implemented.  The current API is documented at
  11 http://wiki.gpodder.org/wiki/Web_Services/API_2.*
  12
  13 The gpodder.net API allows clients to interact with gpodder.net. The API is
  14 provided via a REST interface, and is free of charge within certain quotas, and
  15 completely free for open source clients (see :ref:`usage`).
  16
  17 Contents
  18 --------
  19
  20 .. toctree::
  21    :maxdepth: 2
  22
  23    usage
  24    integration
  25    reference/index
  26    deprecation
  27    libraries