https://github.com/jupyterhub/mybinder.org-user-guide

Turn a Git repo into a collection of interactive notebooks. This is Binder's user documentation repository.
https://github.com/jupyterhub/mybinder.org-user-guide

binder binderhub jupyter-notebooks jupyterhub kubernetes

Last synced: 5 days ago
JSON representation

Turn a Git repo into a collection of interactive notebooks. This is Binder's user documentation repository.

• Host: GitHub
• URL: https://github.com/jupyterhub/mybinder.org-user-guide
• Owner: jupyterhub
• License: bsd-3-clause
• Created: 2017-08-17T05:21:49.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-12-20T00:05:34.000Z (27 days ago)
• Last Synced: 2025-01-03T15:08:57.331Z (12 days ago)
• Topics: binder, binderhub, jupyter-notebooks, jupyterhub, kubernetes
• Language: Python
• Homepage: https://mybinder.readthedocs.io
• Size: 705 KB
• Stars: 167
• Watchers: 14
• Forks: 105
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
# `mybinder.org` user documentation

[![Documentation Status](https://readthedocs.org/projects/mybinder/badge/?version=latest)](https://mybinder.readthedocs.io/en/latest/?badge=latest)

[![Join the chat at https://gitter.im/jupyterhub/binder](https://badges.gitter.im/jupyterhub/binder.svg)](https://gitter.im/jupyterhub/binder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

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](https://github.com/jupyterhub/binderhub)**

**For repo2docker, the open-source technology to turn Git repositories into Jupyter enabled Docker Images, please visit [jupyter/repo2docker](https://github.com/jupyter/repo2docker)**

 For deployment of the website [mybinder.org](https://mybinder.org), please

 visit [mybinder.org-deploy](https://github.com/jupyterhub/mybinder.org-deploy).  

BinderHub uses Helm to configure and manage deployment

of the Binder service. For details about this deployment, please visit [helm-chart](https://github.com/jupyterhub/helm-chart).  

## Maintainers

Binder is maintained by the [Binder team](https://github.com/jupyterhub/team-compass#binder-team).  Administration is managed at [team compass](https://github.com/jupyterhub/team-compass).

The JupyterHub team also maintains analysis of binder data including [billing data](https://github.com/jupyterhub/binder-billing) and [activity data](https://github.com/jupyterhub/binder-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`](https://nox.thea.codes/en/stable/).

`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:

```bash

pip install nox

nox -s docs

```

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

```bash

nox -s docs -- live

```

Alternatively, you may build the documentation directly with Sphinx:

```bash

pip install -r doc/doc-requirements.txt

sphinx-build -b html doc doc/_build

```