mybinder.org user documentation

This repository contains the documentation and usage instructions for the mybinder.org service.

Related Repositories

For BinderHub, the open-source technology that runs mybinder.org, please visit jupyterhub/binderhub

For repo2docker, the open-source technology to turn Git repositories into Jupyter enabled Docker Images, please visit jupyter/repo2docker

For deployment of the website mybinder.org, please visit mybinder.org-deploy.

BinderHub uses Helm to configure and manage deployment of the Binder service. For details about this deployment, please visit helm-chart.

Maintainers

Binder is maintained by the Binder team. Administration is managed at team compass.

The JupyterHub team also maintains analysis of binder data including billing data and activity data.

Build the documentation

This documentation is built with the Sphinx Documentation engine. The easiest way to build the documentation is with the tool nox. nox is kind-of like a Makefile, it is a way to automatically install environments and run commands locally. To build this documentation with nox, run:

pip install nox
nox -s docs

or to launch a live server that re-builds and re-loads pages as you save files:

nox -s docs -- live

Alternatively, you may build the documentation directly with Sphinx:

pip install -r doc/doc-requirements.txt
sphinx-build -b html doc doc/_build