Skip to main content

Sphinx extensions for writing interactive documents.

Project description


.. image::
:alt: Join the chat at

.. image::
:alt: PyPI Version

.. image::
:alt: PyPI Monthly downloads

.. image::

Packaging of the Runestone components for publishing educational materials using Sphinx and restructuredText. Check out the `Overview <>`_ To see all of the extensions in action.


Summer 2018 has brought some great updates to our documentation. You will find the new docs on `here <>`_

If you want to report any issues with the docs or submit PRs to improve them please do so on `github <>`_

Quick Start

If you are completely new to pip and github text editors, I have written a more thorough getting started
tutorial `on my blog <>`_
Otherwise, you can install everything you need with one simple command! (Although I recommend that you first create a virtual environment for your work.)

**Install and make a Python virtualenv**

* Documentation here:
* Video here:
* For the impatient:


$ sudo pip install virtualenv
$ virtualenv /path/to/home/MyEnv
$ source /path/to/home/MyEnv/bin/activate

* You will need to do the last command **every time** you want to work on RunestoneComponents. If you have not used Python virtual environments before I strongly recommend reading the docs or watching the video

With the virtual environment installed and configured you can continue.


pip install runestone

Or, if you prefer to live on the development edge, you can check out the very latest from:


pip install git+git://

To start a project, create a new folder and then run the following command (installed by pip) in that new folder ``runestone init`` For example:


mkdir myproject
cd myproject
runestone init

The init command will ask you some questions and setup a default project for you.

To build the included default project run


runestone build

You will now have a build folder with a file index.html in it, along with some default content. The contents of the build folder are suitable for hosting anywhere that you can serve static web content from! For a small class you could even serve the content using the builtin Python webserver.


$ runestone serve

Now from your browser you can open up ``http://localhost:8000/index.html`` You should see the table of contents for a sample page. If you edit ``_sources/index.html`` or ``_sources/overview.rst`` and then rebuild and serve again you will see your changes. The best documentation is probably the overview.rst file itself, as it demonstrates how to use all of the common components and shows most of their options.

**Windows Users** I have tested the installation, along with init, build, and serve on Windows 8.1.
The biggest pain is probably setting your PATH environment variable so you can simply type the commands
from the shell. Please note that I am not a regular user of windows, I only test things on my VMWare
installation every so often. If you are new to using Python on windows I recommend you check out this
link on `Using Python with Windows <>`_

Developing and Hacking

So, you would like to help out with developing the Runestone Components. What do you need to know? Check out the `Development Roadmap <>`_ to get an understanding of our migration towards webcomponents.

1. Make a Fork of this repository.
2. Set up your environment on your development machine

1. Make a virtual environment for testing and working (I recommend pyvenv-3.4 as it is baked in to Python 3.4 and higher)
2. To use Runestone Components, rather than following the instructions above for installing runestone simply run ``pip install -e .`` from the top level runestone directory. This will install all of the required prerequisites and setup the runestone install as a link to the development directory.

3. When you have some changes to share, make a Pull Request.

(See the RunestoneServer repository and **** for more complete documentation on how this project works.)

Writing Tests

A great way to contribute to the Runestone Components repository is to add to our test suite.

Our goal is to have unit tests which rely on Selenium (a library that helps simulate interactions in a web browser) for each directive, to see if the JavaScript that powers the directives is working correctly.

**In order to get started with writing a test/writing additional tests, you will need the following:**

* Download the latest `ChromeDriver <>`_., which is a driver that simulates Google Chrome.

* On linux you will need to install Xvfb ``apt-get install xvfb``

* You'll also need to have done the above installation.

* You should be using virtual environment,
you'll need a clone of the RunestoneComponents repository,
and you'll need to have done ``pip install -e .`` from
the top level of the RunestoneComponents directory.

* If you have installed RunestoneComponents in your virtualenv using ``pip install -e .``,
then you should have all the python dependencies you need.

* ``pip install selenium`` in the virtualenv you're using for Runestone Components development
* ``pip install pyvirtualdisplay``

**To run tests:**

* Make sure the directory containing the PhantomJS executable is in your ``PATH`` environment variable. e.g. ``PATH=$PATH:path/to/virtualenv/directory/where/it/is/here`` at your command line (or edit your ``.bash_profile``). It should live in the site-packages/selenium/webdriver/ directory of your virtualenv.

* Check out the existing tests, e.g. the ```` file that tests the Question directive, which you can find at the path ``/runestone/question/test/``, for an example.

* Each directive's individual set of tests requires a mini book. You'll see a ``_sources`` folder for each existing test containing an ``index.rst`` file. That file contains a title, as required by ``.rst``, and whatever directive examples you want to test.

* Finally, to run a test, ensuring that you have accessed a directive folder, type the following at the command prompt:

* ``python -m unittest discover``

.. note::

8081 is the default test port.
If you are running another server on this port, you may encounter an error.
See the Python files, e.g. ````, to see how this is set up.

You should then see some test output, showing a pass (``ok``), FAIL, or error(s).

If you have an error relating to PhantomJS/a driver in the output, you probably have a PATH or driver installation problem.

**To write a new test:**

* Create a ``test`` directory inside a directive's folder

* Create a Python file to hold the test suite inside that directory, e.g. ````

* Run ``runestone init`` inside that folder and answer the following prompts

* Write the appropriate directive example(s) inside the ``index.rst`` file (which will be created as a result of ``runestone init``)

* Edit the Python file you created as appropriate (see documentation for the Python ``unittest`` module `here <>`_.)

Notes for more Advanced Users

If you already have an existing `Sphinx <>`_ project and you want to incorporate the runestone components into your project you can just make a couple of simple edits to your existing ```` file.

* First add the following import line ``from runestone import runestone_static_dirs, runestone_extensions``
* Then modify your extensions. You may have a different set of extensions already enabled, but it doesn't matter just do this: ``extensions = ['sphinx.ext.mathjax'] + runestone_extensions()``
* Then modify your html_static_path: ``html_static_path = ['_static'] + runestone_static_dirs()`` Again you may have your own set of static paths in the initial list.

See to get a sense for how this is all going to come together.

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for runestone, version 3.2.4
Filename, size File type Python version Upload date Hashes
Filename, size runestone-3.2.4-py2.py3-none-any.whl (4.1 MB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size runestone-3.2.4.tar.gz (3.9 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page