Skip to content

Commit

Permalink
Add related projects section
Browse files Browse the repository at this point in the history
  • Loading branch information
SylvainCorlay committed Jun 30, 2018
1 parent dfca717 commit f15bc65
Show file tree
Hide file tree
Showing 9 changed files with 166 additions and 3 deletions.
13 changes: 11 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,19 @@ C++ implementation of the Jupyter Kernel protocol
Introduction
------------

``xeus`` is a library meant to facilitate the implementation of kernels for Jupyter. It takes the burden of implementing the Jupyter Kernel protocol so developers can focus on implementing the interpreter part of the kernel.
``xeus`` is a library 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.
This software is licensed under the BSD-3-Clause license. See the LICENSE file
for details.

.. toctree::
:caption: INSTALLATION
Expand All @@ -33,3 +37,8 @@ This software is licensed under the BSD-3-Clause license. See the LICENSE file f
:maxdepth: 2

usage

.. toctree::
:caption: MISCELLANEOUS

related
Binary file added docs/source/juniper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 65 additions & 0 deletions docs/source/related.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
.. Copyright (c) 2017, Johan Mabille, Loic Gouarin 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.
.. raw:: html

<style>
h2 {
display: none;
}
</style>

Related projects
================

xeus-cling
----------

.. image:: xeus-cling.svg
:alt: xeus-cling

The `xeus-cling`_ project is a Jupyter kernel for the C++ programming language
based on the Cling C++ interpreter from CERN and Xeus, the native
implementation of the Jupyter protocol.

.. image:: xeus-cling-screenshot.png
:alt: C++ notebook

xwidgets
---------

.. image:: xwidgets.svg
:alt: xwidgets

The xwidgets_ project is a C++ implementation of the Jupyter interactive
widgets protocol. The Python reference implementation is available in the
ipywidgets ipywidgets_ project.

xwidgets enables the use of the Jupyter interactive widgets in the C++
notebook, powered by the xeus-cling kernel and the cling C++ interpreter from
CERN. xwidgets can also be used to create applications making use of the
Jupyter interactive widgets without the C++ kernel per se.

.. image:: xwidgets-screencast.gif
:alt: xwidgets screencast

JuniperKernel
-------------

.. image:: juniper.png
:alt: JuniperKernel

The JuniperKernel_ project is a Jupyter kernel for the R programming language
built with Xeus and Rcpp_.

.. image:: rwidgets-screenshot.png
:alt: rwidgets screenshot

.. _xeus-cling: https://github.com/QuantStack/xeus-cling
.. _xwidgets: https://github.com/QuantStack/xwidgets
.. _JuniperKernel: https://github.com/JuniperKernel/JuniperKernel
.. _Rcpp: https://github.com/RcppCore/Rcpp
.. _ipywidgets: https://github.com/jupyter-widgets/ipywidgets
Binary file added docs/source/rwidgets-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/xeus-cling-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 50 additions & 0 deletions docs/source/xeus-cling.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/xwidgets-screencast.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions docs/source/xwidgets.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion include/xeus/xcomm.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
#ifndef XCOMM_HPP
#define XCOMM_HPP

#include <iostream>
#include <functional>
#include <list>
#include <map>
Expand Down

0 comments on commit f15bc65

Please sign in to comment.