..
    Copyright (C) 2018 CERN.

    Asclepias Broker is free software; you can redistribute it and/or modify it
    under the terms of the MIT License; see LICENSE file for more details.


.. include:: ../README.rst

User's Guide
------------

This part of the documentation will show you how to get started using the
Asclepias Broker.

.. toctree::
   :maxdepth: 2

   installation
   configuration
   usage

Architecture
------------

This section describes the design principles of the Asclepias Broker.

.. toctree::
   :maxdepth: 2

   architecture/data-model
   architecture/systems
   architecture/interoperability

REST API
--------

This section documents the REST APIs exposed by the service.

.. toctree::
   :maxdepth: 2

   rest_api

API Reference
-------------

If you are looking for information on a specific function, class or method,
this part of the documentation is for you.

.. toctree::
   :maxdepth: 2

   api/core
   api/events
   api/graph
   api/metadata
   api/search
   api/monitoring
   api/harvester

Additional Notes
----------------

Notes on how to contribute, legal information and changes are here for the
interested.

.. toctree::
   :maxdepth: 1

   contributing
   changes
   license
   authors