Pebbles (formerly Pouta Blueprints) is a frontend to manage cloud resources and lightweight user accounts. Currently supported resource types are:

• OpenStack driver, which can be used to launch instances on OpenStack cloud.
• Docker driver, for running web notebook instances in Docker containers on a pool of virtual machines.
• Pouta Virtualcluster , which can be used to launch clusters on cPouta.

Additional resources can be added by implementing the driver interface. ToDo: hyperlink to new docs.

The system comes with Sphinx RST documentation under doc/. Convention is to have as much as possible as docstrings close to the code that implements. Generic things like system descriptions may also be under doc/source. :

$ mkvirtualenv pb-doc
(pb-doc) $ pip install -r requirements.txt
(pb-doc) $ cd doc && make html

Will build the html documentation under doc/build. There is a requirement of graphviz for creating system structure graphs.

The documentation is hosted in GitHub pages and built using Travis-Sphinx.

$ workon pb-doc (pb-doc)$ travis-sphinx --branches=doc/sphinx --source=doc/source build

Can save you a lot of trouble.