Skip to content
This repository has been archived by the owner on Nov 29, 2019. It is now read-only.

WIP: demo of how to use index.ipynb with current nbsite #62

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
8 changes: 8 additions & 0 deletions doc/_index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. toctree::
:hidden:
:maxdepth: 2

Introduction <self>
User Guide <user_guide/index>
FAQ
About <about>
31 changes: 3 additions & 28 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,4 @@
**********
ParamBokeh
**********
.. notebook:: parambokeh ../examples/index.ipynb
:offset: 0

**Generate bokeh widgets for parameterized objects**

ParamBokeh is an `open-source
<https://github.com/ioam/holoviews/blob/master/LICENSE.txt>`_ Python
library that allows you to easily create GUIs from existing objects
(in Jupyter notebooks, Bokeh apps, and potentially more)

The `User Guide <user_guide>`_ shows the concepts involved with ParamBokeh
and should help you get started using it as quickly as possible.

Please feel free to report `issues
<https://github.com/ioam/parambokeh/issues>`_ or `contribute code
<https://help.github.com/articles/about-pull-requests>`_. You are also
welcome to chat with the developers on `gitter
<https://gitter.im/ioam/holoviews>`_.


.. toctree::
:hidden:
:maxdepth: 2

Introduction <self>
User Guide <user_guide/index>
FAQ
About <about>
.. include:: _index.rst
32 changes: 32 additions & 0 deletions examples/index.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# ParamBokeh"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"**Generate bokeh widgets for parameterized objects**\n",
"\n",
"ParamBokeh is an [open-source](https://github.com/ioam/parambokeh/blob/master/LICENSE) Python library that allows you to easily create GUIs from existing objects (in Jupyter notebooks, Bokeh apps, and potentially more).\n",
"\n",
"The [User Guide](user_guide) shows the concepts involved with ParamBokeh and should help you get started using it as quickly as possible.\n",
"\n",
"Please feel free to report [issues](https://github.com/ioam/parambokeh/issues) or [contribute code](https://help.github.com/articles/about-pull-requests). You are also welcome to chat with the developers on [gitter](https://gitter.im/ioam/holoviews)."
]
}
],
"metadata": {
"language_info": {
"name": "python",
"pygments_lexer": "ipython3"
}
},
"nbformat": 4,
"nbformat_minor": 2
}