"Where can I find more beginner-friendly documentation?"
The interactive training part of the documentation is at training.brightway.dev
.
"How can I contribute to the documentation?"
If you are familiar with Sphinx, you can add your changes to a fork of this repo and open a pull request.
If you would rather get help from a developer, please start a new discussion here. Your suggestions/additions will be added for you.
"Where can I get help beyond the documentation?"
Use the Gitter channel linked above.
- Clone the repository
- Install the
sphinx
Python package and other required packages (themes, etc.). A template conda environment yaml file is provided for convenience atsetup/conda_environment.yml
conda env create -f setup/conda_environment.yml
- Edit content or add new files
- Build the documentation by running, from within the repository root
make html
- Preview the documentation by opening
_build/html/index.html
Compare the sphinx
:
Compare the readthedocs.org
: