diff --git a/doc/_index.rst b/doc/_index.rst new file mode 100644 index 0000000..929728f --- /dev/null +++ b/doc/_index.rst @@ -0,0 +1,8 @@ +.. toctree:: + :hidden: + :maxdepth: 2 + + Introduction + User Guide + FAQ + About diff --git a/doc/index.rst b/doc/index.rst index 62124a5..6b32f8e 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,29 +1,4 @@ -********** -ParamBokeh -********** +.. notebook:: parambokeh ../examples/index.ipynb + :offset: 0 -**Generate bokeh widgets for parameterized objects** - -ParamBokeh is an `open-source -`_ Python -library that allows you to easily create GUIs from existing objects -(in Jupyter notebooks, Bokeh apps, and potentially more) - -The `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 -`_ or `contribute code -`_. You are also -welcome to chat with the developers on `gitter -`_. - - -.. toctree:: - :hidden: - :maxdepth: 2 - - Introduction - User Guide - FAQ - About +.. include:: _index.rst diff --git a/examples/index.ipynb b/examples/index.ipynb new file mode 100644 index 0000000..2cadd6a --- /dev/null +++ b/examples/index.ipynb @@ -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 +}