orcestra-campaign / book

ORCESTRA documentation
8 stars 37 forks source link

The ORCESTRA book

This repo collects all information to the ORCESTRA campaign in the form of a book. For now, the rendered book (website) is deployed to https://orcestra-campaign.org/

The book is thought to grow and include information on

Building the book

You can build the book from within the repo's root folder by running:

jupyter-book build orcestra_book/

A fully-rendered HTML version of the book will be built in orcestra-book/_build/html/. You can have a look at it by opening the _build/html/index.html file in your browser.

In case the book builds without errors, but your changes don't seem to get rendered it might be due to the cache. You can force the book to be built from scratch by removing the existing orcestra-book/_build/ directory before building the book.

Contributing

This is a project from the community for you and for the community and it is under constant improvement. Everyone is welcome to contribute with scripts, ideas, suggestions, by opening issues and making pull requests. More details can be found here.

Credits

This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.