Brightway Interactive Learning (based on Jupyter Book)
Maintainance Team: @michaelweinold
The interactive learning and teaching documentation for the Brightway life-cycle assessment software package. Readthedocs.org with the Jupyter Book Theme and the Thebe tool are used to build/host the interactive documentation.
static documentation | interactive documentation | development playground |
---|---|---|
docs.brightway.dev | learn.brightway.dev | live.brightway.dev |
git clone https://github.com/brightway-lca/brightway-book.git
Set up a Python virtual environment that includes all packages required to build the documentation. A Conda environment file is provided for convenient setup. The file is located at ./environment.yml
. Install the environment jbook
by running from the repository root directory:
conda env create -f environment.yml
and activate the environment:
conda activate jbook
Tip
You can check the Jupyter Book documentation for further information on how to structure your content.
- You can build the documentation by running the
build
command:
jupyter-book build ./
- Preview the built documentation by opening the generated
html
file:
_build/html/index.html
- Create a pull request to have a maintainer merge your changes into the
main
branch. As soon aschanges have been merged, Readthedocs.org will build the documentation and deploy it.
Compare the jupyter-book
: