Merge pull request #14 from pbugnion/sphinx-docs

Sphinx documentation
pbugnion · Jan 28, 2018 · 205fbb3 · 205fbb3
2 parents 99b9270 + e45e3cd
commit 205fbb3
Show file tree

Hide file tree

Showing 16 changed files with 656 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,12 @@
 
 *.swp
+*.pyc
 
 node_modules
 __pycache__
 dist/
 npm-debug.log
 package-lock.json
 ipywidgets_server.egg-info
+
+docs/build/
diff --git a/README.md b/README.md
@@ -52,6 +52,10 @@ To serve the widget, go to the directory containing `example.py` and run:
 $ ipywidgets-server example:vbox
 ```
 
+This will serve the widget on `http://localhost:8866`:
+
+![example-widget](docs/source/_images/simple-example.gif)
+
 The command line argument is `<module name>:<object name>`, where `<module
 name>` is the name of a Python module that can be imported, and `<object
 name>` is the name of the variable that holds the widget to display.

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = ipywidgets_server
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/run_dev.py b/docs/run_dev.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+
+"""
+Run a web server displaying the current documentation.
+The server reloads when there are changes to the source.
+
+This requires the livereload module
+(https://github.com/lepture/python-livereload/).
+
+Run from this directory:
+$ python run_dev.py
+"""
+
+from livereload import Server, shell
+
+PORT = '8080'
+BUILD = shell('make html', cwd='.')
+
+server = Server()
+server.watch('source/*', BUILD)
+server.watch('../ipywidgets_server/', BUILD)
+server.serve(root='build/html', port=PORT)
diff --git a/docs/source/_images/simple-example.gif b/docs/source/_images/simple-example.gif
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,169 @@
+# -*- coding: utf-8 -*-
+#
+# ipywidgets_server documentation build configuration file, created by
+# sphinx-quickstart on Sat Nov 18 09:28:24 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Read version from version file
+import sys
+import os
+
+here = os.path.dirname(os.path.realpath(__file__))
+VERSION_FILE = os.path.join(here, '..', '..', 'ipywidgets_server', '_version.py')
+version_namespace = {}
+with open(VERSION_FILE) as f:
+    exec(f.read(), {}, version_namespace)
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.todo',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'ipywidgets_server'
+copyright = u'2017, Pascal Bugnion'
+author = u'Pascal Bugnion'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = version_namespace['__version__']
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ipywidgets_serverdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'ipywidgets_server.tex', u'ipywidgets\\_server Documentation',
+     u'Pascal Bugnion', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'ipywidgets_server', u'ipywidgets_server Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'ipywidgets_server', u'ipywidgets_server Documentation',
+     author, 'ipywidgets_server', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+
diff --git a/docs/source/images/matplotlib-simple.png b/docs/source/images/matplotlib-simple.png
diff --git a/docs/source/images/matplotlib-sine.png b/docs/source/images/matplotlib-sine.png
diff --git a/docs/source/images/stock-price.png b/docs/source/images/stock-price.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,16 @@
+.. ipywidgets_server documentation master file, created by
+   sphinx-quickstart on Sat Nov 18 09:28:24 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+IPywidgets server
+=================
+
+`IPywidgets server` lets you serve Jupyter widgets outside of a Jupyter
+Notebook. Any Python callback defined on your widgets will work as in the
+notebook.
+
+
+.. toctree::
+    intro
+    tutorials
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
@@ -0,0 +1,51 @@
+
+Getting started: 30 seconds with IPywidgets server
+==================================================
+
+Let's create a simple widget::
+
+    # example.py
+
+    from ipywidgets import IntSlider, Text, VBox
+    s = IntSlider(max=200, value=100)
+    t = Text()
+
+
+    def update_text(change=None):
+        t.value = str(float(s.value) ** 2)
+
+
+    s.observe(update_text, names='value')
+    update_text()
+    vbox = VBox([s, t])
+
+To serve this, just run the following, in the directory containing ``example.py``:
+
+.. code-block:: bash
+
+   $ ipywidgets-server example:vbox
+
+This will serve the widget on ``http://localhost:8866/``:
+
+.. image:: _images/simple-example.gif
+
+The command line argument, ``example:vbox``, is ``<module name>:<object name>``,
+where ``<module name>`` is the name of a Python module that can be imported (for
+instance, a file in the current directory, without the ``.py`` extension or a
+Python package that is installed in your environment), and ``<object name>`` is
+the name of the variable that holds the widget to display.
+
+For information on other command line arguments, run::
+
+    $ ipywidgets-server --help
+
+Installation
+============
+
+Install `IPywidgets server` with:
+
+.. code-block:: bash
+
+    $ pip install ipywidgets_server
+
+Currently, `IPywidgets server` only runs on Python 3.6.