.. Copyright (c) 2016, Johan Mabille and Sylvain Corlay

   Distributed under the terms of the BSD 3-Clause License.

   The full license is in the file LICENSE, distributed with this software.

.. image:: xeus.svg
   :alt: xeus

C++ implementation of the Jupyter Kernel protocol

Introduction
------------

``xeus`` is a framework meant to facilitate the implementation of kernels for
Project Jupyter. It takes the burden of implementing the Jupyter Kernel
protocol so developers can focus on implementing the interpreter part of the
kernel.

Licensing
---------

We use a shared copyright model that enables all contributors to maintain the
copyright on their contributions.

This software is licensed under the BSD-3-Clause license. See the LICENSE file
for details.

.. toctree::
   :caption: INSTALLATION
   :maxdepth: 2

   installation

.. toctree::
   :caption: USAGE
   :maxdepth: 3

   usage
   kernel_implementation
   kernel_customization

.. toctree::
   :caption: DEVELOPER SECTION
   :maxdepth: 2

   dev
   server

.. toctree::
   :caption: MISCELLANEOUS

   related
