samueldmq/infosystem

View on GitHub
docs/source/index.rst

Summary

Maintainability
Test Coverage
.. infosystem documentation master file, created by
   sphinx-quickstart on Sat Jun 17 09:37:30 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


.. toctree::
   :hidden:
   :maxdepth: 1

   concepts
   users
   operators
   developers


infosystem
==========

infosystem is a simple framework for writing RESTFul services in just a few
lines of code. The key word here is *simple*.

Example
-------

Let's write a service that manages foo resources.

.. code-block:: python
   :linenos:

   import infosystem

   class Foo(infosystem.Resource):
       name = Column(db.String(80), nullable=False)


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`