Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# ![xeus-python](docs/source/xeus-python.svg)

[![Travis](https://travis-ci.org/QuantStack/xeus-python.svg?branch=master)](https://travis-ci.org/QuantStack/xeus-python)
[![Appveyor](https://ci.appveyor.com/api/projects/status/jh45g5pj44jqj8vw?svg=true)](https://ci.appveyor.com/project/QuantStack/xeus-python)
[![Documentation Status](http://readthedocs.org/projects/xeus-python/badge/?version=latest)](https://xeus-python.readthedocs.io/en/latest/?badge=latest)
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PROJECT_NAME = "xeus-cling"
PROJECT_NAME = "xeus-python"
XML_OUTPUT = xml
INPUT = ../include
GENERATE_LATEX = NO
Expand Down
2 changes: 1 addition & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: xeus-cling-docs
name: xeus-python-docs

channels:
- conda-forge
Expand Down
10 changes: 5 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ def setup(app):
app.add_stylesheet("main_stylesheet.css")

extensions = ['breathe']
breathe_projects = { 'xeus-cling': '../xml' }
breathe_projects = { 'xeus-python': '../xml' }
templates_path = ['_templates']
html_static_path = ['_static']
source_suffix = '.rst'
master_doc = 'index'
project = 'xeus-cling'
copyright = '2017, Johan Mabille, Loic Gouarin and Sylvain Corlay'
author = 'Johan Mabille, Loic Gouarin and Sylvain Corlay'
project = 'xeus-python'
copyright = '2017, Martin Renou, Johan Mabille, Sylvain Corlay and Wolf Vollprecht'
author = 'Martin Renou, Johan Mabille, Sylvain Corlay and Wolf Vollprecht'

html_logo = 'quantstack-white.svg'

exclude_patterns = []
highlight_language = 'c++'
pygments_style = 'sphinx'
todo_include_todos = False
htmlhelp_basename = 'xeus-clingdoc'
htmlhelp_basename = 'xeus-pythondoc'
Binary file removed docs/source/display.png
Binary file not shown.
Binary file removed docs/source/file_magic.png
Binary file not shown.
Binary file removed docs/source/help.png
Binary file not shown.
Binary file removed docs/source/image.png
Binary file not shown.
17 changes: 5 additions & 12 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
.. Copyright (c) 2017, Johan Mabille, Loic Gouarin and Sylvain Corlay
.. Copyright (c) 2017, Martin Renou, Johan Mabille, Sylvain Corlay and
Wolf Vollprecht

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

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

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

xeus-cling is a Jupyter kernel for C++ based on the C++ interpreter cling and the native implementation of the Jupyter protocol xeus.
xeus-python is a Jupyter kernel for Python based on the C++ implementation of the Jupyter protocol xeus.

Introduction
------------
Expand All @@ -27,11 +28,3 @@ This software is licensed under the BSD-3-Clause license. See the LICENSE file f
:maxdepth: 2

installation

.. toctree::
:caption: USAGE
:maxdepth: 2

magics
rich_display
inline_help
93 changes: 0 additions & 93 deletions docs/source/inline_help.rst

This file was deleted.

19 changes: 3 additions & 16 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. Copyright (c) 2017, Johan Mabille, Loic Gouarin and Sylvain Corlay
.. Copyright (c) 2017, Martin Renou, Johan Mabille, Sylvain Corlay and
Wolf Vollprecht

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

Expand All @@ -20,23 +21,10 @@
Installation
============

.. image:: conda.svg

Using the conda package
-----------------------

A package for xeus-cling is available on the conda package manager.

.. code::

conda install -c QuantStack -c conda-forge xeus-cling

.. image:: cmake.svg

From source with cmake
----------------------

You can also install ``xeus-cling`` from source with cmake. This requires that you have all the dependencies installed in the same prefix.
You can install ``xeus-python`` from source with cmake. This requires that you have all the dependencies installed in the same prefix.

.. code::

Expand All @@ -54,4 +42,3 @@ On Windows platforms, from the source directory:
cmake -G "NMake Makefiles" -DCMAKE_INSTALL_PREFIX=/path/to/prefix ..
nmake
nmake install

77 changes: 0 additions & 77 deletions docs/source/magics.rst

This file was deleted.

Loading