generate docs without conversion

.bumpversion.cfg

@@ -9,3 +9,5 @@ tag_name = {new_version}
 
 [bumpversion:file:src/jupyter_contrib_nbextensions/__init__.py]
 
+[bumpversion:file:docs/source/conf.py]
+

.gitignore

@@ -15,6 +15,8 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build
+# auto-generated Sphinx files
+docs/source/nbextensions.rst
 
 .idea
 

.travis.yml

@@ -19,6 +19,10 @@ matrix:
     - os: linux
       python: '3.4'
       env: TOXENV=lint
+    # check docs build correctly
+    - os: linux
+      python: '3.4'
+      env: TOXENV=docs
     # linux, various python and notebook versions
     - os: linux
       python: '3.4'

README.md

@@ -1,13 +1,19 @@
 Jupyter notebook extensions
 ===========================
 
-[![Join the chat at https://gitter.im/ipython-contrib/jupyter_contrib_nbextensions](https://img.shields.io/gitter/room/ipython-contrib/jupyter_contrib_nbextensions.svg?maxAge=3600)](https://gitter.im/ipython-contrib/jupyter_contrib_nbextensions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub issues](https://img.shields.io/github/issues/ipython-contrib/jupyter_contrib_nbextensions.svg?maxAge=3600)](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/issues)
-<br/>
-[![Travis-CI Build Status](https://img.shields.io/travis/ipython-contrib/jupyter_contrib_nbextensions.svg?maxAge=3600&label=Travis)](https://travis-ci.org/ipython-contrib/jupyter_contrib_nbextensions) [![Appveyor Build status](https://img.shields.io/appveyor/ci/jcb91/ipython-notebook-extensions-ynb9f.svg?maxAge=3600&label=Appveyor)](https://ci.appveyor.com/project/jcb91/ipython-notebook-extensions-ynb9f) [![Coveralls python test coverage](https://img.shields.io/coveralls/ipython-contrib/jupyter_contrib_nbextensions/master.svg?maxAge=3600&label=Coveralls)](https://coveralls.io/github/ipython-contrib/jupyter_contrib_nbextensions) [![Codecov python test coverage](https://img.shields.io/codecov/c/github/ipython-contrib/jupyter_contrib_nbextensions/master.svg?maxAge=3600&label=Codecov)](https://codecov.io/gh/ipython-contrib/jupyter_contrib_nbextensions)
+[![Join the chat at https://gitter.im/ipython-contrib/jupyter_contrib_nbextensions](https://img.shields.io/gitter/room/ipython-contrib/jupyter_contrib_nbextensions.svg?maxAge=3600)](https://gitter.im/ipython-contrib/jupyter_contrib_nbextensions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Documentation Status](https://readthedocs.org/projects/jupyter-contrib-nbextensions/badge/?version=latest)](http://jupyter-contrib-nbextensions.readthedocs.io/en/latest/)
+[![Documentation Status](https://readthedocs.org/projects/jupyter-contrib-nbextensions/badge/?version=stable)](http://jupyter-contrib-nbextensions.readthedocs.io/en/stable/)
+[![GitHub issues](https://img.shields.io/github/issues/ipython-contrib/jupyter_contrib_nbextensions.svg?maxAge=3600)](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/issues)
 <br/>
-[![GitHub tag](https://img.shields.io/github/tag/ipython-contrib/jupyter_contrib_nbextensions.svg?maxAge=3600)](https://github.com/ipython-contrib/jupyter_contrib_nbextensions) [![Github All Releases](https://img.shields.io/github/downloads/ipython-contrib/jupyter_contrib_nbextensions/total.svg?maxAge=3600)](https://github.com/ipython-contrib/jupyter_contrib_nbextensions) [![PyPI](https://img.shields.io/pypi/v/jupyter_contrib_nbextensions.svg?maxAge=3600)](https://pypi.python.org/pypi/jupyter_contrib_nbextensions) [![PyPI](https://img.shields.io/pypi/dm/jupyter_contrib_nbextensions.svg?maxAge=3600)](https://pypi.python.org/pypi/jupyter_contrib_nbextensions)
+[![Travis-CI Build Status](https://img.shields.io/travis/ipython-contrib/jupyter_contrib_nbextensions.svg?maxAge=3600&label=Travis)](https://travis-ci.org/ipython-contrib/jupyter_contrib_nbextensions)
+[![Appveyor Build status](https://img.shields.io/appveyor/ci/jcb91/ipython-notebook-extensions-ynb9f.svg?maxAge=3600&label=Appveyor)](https://ci.appveyor.com/project/jcb91/ipython-notebook-extensions-ynb9f)
+[![Coveralls python test coverage](https://img.shields.io/coveralls/ipython-contrib/jupyter_contrib_nbextensions/master.svg?maxAge=3600&label=Coveralls)](https://coveralls.io/github/ipython-contrib/jupyter_contrib_nbextensions)
+[![Codecov python test coverage](https://img.shields.io/codecov/c/github/ipython-contrib/jupyter_contrib_nbextensions/master.svg?maxAge=3600&label=Codecov)](https://codecov.io/gh/ipython-contrib/jupyter_contrib_nbextensions)
 <br/>
-[![Documentation Status](https://readthedocs.org/projects/jupyter-contrib-nbextensions/badge/?version=latest)](http://jupyter-contrib-nbextensions.readthedocs.io/en/latest/)
+[![GitHub tag](https://img.shields.io/github/tag/ipython-contrib/jupyter_contrib_nbextensions.svg?maxAge=3600&label=Github)](https://github.com/ipython-contrib/jupyter_contrib_nbextensions)
+[![PyPI](https://img.shields.io/pypi/v/jupyter_contrib_nbextensions.svg?maxAge=3600)](https://pypi.python.org/pypi/jupyter_contrib_nbextensions)
+[![Anaconda cloud](https://anaconda.org/conda-forge/jupyter_contrib_nbextensions/badges/version.svg)](https://anaconda.org/conda-forge/jupyter_contrib_nbextensions)
 
 This repository contains a collection of extensions that add functionality to the Jupyter notebook.
 These extensions are mostly written in Javascript and will be loaded locally in
@@ -44,15 +50,15 @@ Documentation for all maintained extensions can be found at
 
 In the 4.x Jupyter repository, all extensions that are maintained and active
 have at least a  yaml file to allow them being configured using the
-[`jupyter_nbextensions_configurator`](https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator)
+[jupyter_nbextensions_configurator](https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator)
 server extension, which is installed as a dependency of this package.
 Most also have a markdown readme file for documentation.
 The `jupyter_nbextensions_configurator` server extension shows an nbextensions
 tab on the main notebook dashboard (file tree page) from which you can see each
 nbextension's markdown readme, and configure its options.
 To view documentation without installing, you can browse the nbextensions
 directory to read markdown readmes on github at
-https://github.com/ipython-contrib/jupyter_contrib_nbextensions/tree/master/src/jupyter_contrib_nbextensions/nbextensions.
+[github.com/ipython-contrib/jupyter_contrib_nbextensions/tree/master/src/jupyter_contrib_nbextensions/nbextensions](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/tree/master/src/jupyter_contrib_nbextensions/nbextensions).
 
 For older releases (2.x and 3.x), look at the [Wiki](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/wiki)
 
@@ -62,19 +68,25 @@ Some extensions are not documented. We encourage you to add documentation for th
 Installation
 ============
 
-To install notebook extensions, three steps are required. First, this Python package needs to be installed.
-Then, the notebook extensions themselves can be copied to the Jupyter data directory.
-Finally, the installed notebook extensions can be enabled, either by using built-in Jupyter commands,
-or more convenient by using the jupyter_nbextensions_configurator server extension.
+To install the `jupyter_contrib_nbextensions` notebook extensions, three steps
+are required. First, the Python pip package needs to be installed. Then, the
+notebook extensions themselves need to be copied to the Jupyter data directory.
+Finally, the installed notebook extensions can be enabled, either by using
+built-in Jupyter commands, or more conveniently by using the
+[jupyter_nbextensions_configurator](https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator)
+server extension, which is installed as a dependency of this repo.
 
-The Python package installation step is necessary to allow painless installation of the extensions togther with
-additional items like nbconvert templates, pre-/postprocessors, and exporters.
+The Python package installation step is necessary to allow painless
+installation of the nbextensions together with additional items like nbconvert
+templates, pre-/postprocessors, and exporters.
 
 
-1. Install the python package
------------------------------
+1\. Install the python package
+------------------------------
+
 
 ### PIP
+
 All of the nbextensions in this repo are provided as parts of a python package,
 which is installable in the usual manner, using `pip` or the `setup.py` script.
 You can install directly from the current master branch of the repository
@@ -84,7 +96,9 @@ You can install directly from the current master branch of the repository
 All the usual pip options apply, e.g. using pip's `--upgrade` flag to force an
 upgrade, or `-e` for an editable install.
 
+
 ### Conda
+
 There are conda packages for the notebook extensions and the notebook extensions configurator
 available from [conda-forge](https://conda-forge.github.io). You can install both using
 
@@ -94,19 +108,21 @@ This also automatically installs the Javascript and CSS files
 (using `jupyter contrib nbextension install --sys-prefix`), so the second installation step
 below can therefore be skipped.
 
+
 ### Installation from cloned Repo
+
 You can also install from a cloned repo, which can be useful for development.
 You can clone the repo using
 
-    git clone https://github.com/ipython-contrib/jupyter_contrib_nbextensions.git jupyter_contrib_nbextensions
+    git clone https://github.com/ipython-contrib/jupyter_contrib_nbextensions.git
 
 Then perform an editable pip install using
 
     pip install -e jupyter_contrib_nbextensions
 
 
-2. Install javascript and css files
------------------------------------
+2\. Install javascript and css files
+------------------------------------
 
 This step copies the nbextensions javascript and css files into the jupyter
 server's search directory. A `jupyter` subcommand is provided which installs
@@ -117,41 +133,42 @@ all of the nbextensions files:
 The command is essentially a wrapper around the notebook-provided
 `jupyter nbextension`, and can take most of the same options, such as `--user`
 to install into the user's home jupyter directories, `--system` to perform
-installation into system-wide jupyter directories, `sys-prefix` to install into
-python's `sys.prefix`, useful for instance in virtual environments, and
+installation into system-wide jupyter directories, `--sys-prefix` to install
+into python's `sys.prefix`, useful for instance in virtual environments, and
 `--symlink` to symlink the nbextensions rather than copying each file
 (recommended).
 
 An analogous `uninstall` command is also provided, to remove all of the
 nbextension files from the jupyter directories.
 
 
-3. Enabling/Disabling extensions
---------------------------------
+3\. Enabling/Disabling extensions
+---------------------------------
 
-To use an nbextension, you’ll also need to enable it, which tells the notebook
+To use an nbextension, you'll also need to enable it, which tells the notebook
 interface to load it. To do this, you can use a Jupyter subcommand:
 
-    jupyter nbextension enable <nbextension>
+    jupyter nbextension enable <nbextension require path>
 
 for example,
 
     jupyter nbextension enable codefolding/main
 
 To disable the extension again, use
 
-    jupyter nbextension disable <nbextension>
+    jupyter nbextension disable <nbextension require path>
 
 **Alternatively**, and more conveniently, you can use the
-[`jupyter_nbextensions_configurator`](https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator)
+[jupyter_nbextensions_configurator](https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator)
 server extension, which is installed as a dependency of this repo, and can be
 used to enable and disable the individual nbextensions, as well as configure
 their options. You just have to open a tab at `http://localhost:8888/nbextensions/` (you may have to adjust the port) and you will have access to a dashboard where extensions can be enabled/disabled via checkboxes. Additionally a short documentation for each extension is displayed and configuration options are presented.
 
-![nbexention_configurator](https://raw.githubusercontent.com/Jupyter-contrib/jupyter_nbextensions_configurator/master/src/jupyter_nbextensions_configurator/static/nbextensions_configurator/icon.png)
+![jupyter_nbextensions_configurator](https://raw.githubusercontent.com/Jupyter-contrib/jupyter_nbextensions_configurator/master/src/jupyter_nbextensions_configurator/static/nbextensions_configurator/icon.png)
 
-4. Migrating from older versions of this repo
----------------------------------------------
+
+4\. Migrating from older versions of this repo
+----------------------------------------------
 
 The `jupyter contrib nbextensions` command also offers a `migrate` subcommand,
 which will
@@ -164,10 +181,12 @@ which will
 
 For complex or customized installation scenarios, please look at the
 documentation for installing notebook extensions, server extensions, nbconvert
-pre/postprocessors and templates on the Jupyter homepage http://www.jupyter.org.
+pre/postprocessors and templates on the [Jupyter homepage](http://www.jupyter.org).
 More information can also be found in the
 [Wiki](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/wiki).
 
+See also [installing Jupyter](http://jupyter.readthedocs.io/en/latest/install.html)
+
 
 Notebook extension structure
 ============================
@@ -189,7 +208,7 @@ Changes
   - New `html_embed` nbconvert exporter
   - Added `select_keymap` nbextension
 * Docs improvements:
-  - get docs readable at http://jupyter-contrib-nbextensions.readthedocs.io/
+  - get docs readable at [jupyter-contrib-nbextensions.readthedocs.io](http://jupyter-contrib-nbextensions.readthedocs.io/)
   - add an auto-enabled nbextension `contrib_nbextensions_help_item`, which
     adds a help menu item to point at RTD
   - Add missing readmes/yaml links to readmes