Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brightway-lca/brightway-book
📖🌿 Interactive jupyter-book Documentation for Brightway
https://github.com/brightway-lca/brightway-book
documentation lca life-cycle-assessment
Last synced: about 2 months ago
JSON representation
📖🌿 Interactive jupyter-book Documentation for Brightway
- Host: GitHub
- URL: https://github.com/brightway-lca/brightway-book
- Owner: brightway-lca
- License: bsd-3-clause
- Created: 2022-08-20T04:35:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T10:15:43.000Z (5 months ago)
- Last Synced: 2024-07-23T12:03:26.622Z (5 months ago)
- Topics: documentation, lca, life-cycle-assessment
- Language: Jupyter Notebook
- Homepage: https://learn.brightway.dev
- Size: 11.6 MB
- Stars: 14
- Watchers: 8
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Brightway Interactive Learning (based on [Jupyter Book](https://jupyterbook.org/en/stable/intro.html))
[](https://github.com/brightway-lca)
 [](https://github.com/brightway-lca/brightway-documentation-readthedocs/discussions) \
Maintainance Team: [@michaelweinold](https://github.com/michaelweinold)
The interactive learning and teaching documentation for the Brightway life-cycle assessment software package. [Readthedocs.org](https://about.readthedocs.com/?ref=readthedocs.com) with the [Jupyter Book Theme](https://jupyterbook.org/en/stable/intro.html) and the [Thebe tool](https://thebe.readthedocs.io/en/stable/) are used to build/host the interactive documentation.
| static documentation | interactive documentation | development playground |
| ---- | ------------- | ------------- |
| [docs.brightway.dev](https://github.com/brightway-lca/brightway-documentation) | [learn.brightway.dev](https://github.com/brightway-lca/brightway-book) | [live.brightway.dev](https://github.com/brightway-lca/brightway-live) |
## Quickstart
### Setup Repository
1. [Clone this repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository):
```bash
git clone https://github.com/brightway-lca/brightway-book.git
```
### Setup Python Environment
Set up a Python virtual environment that includes all packages required to build the documentation. A [Conda environment file](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) is provided [for convenient setup](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file). The file is located at [``./environment.yml``](environment.yml). Install the environment `jbook` by running from the repository root directory:
```bash
conda env create -f environment.yml
```
and activate the environment:
```bash
conda activate jbook
```
### Building the Documentation
> [!TIP]
> You can check [the Jupyter Book documentation](https://jupyterbook.org/en/stable/intro.html) for further information on how to structure your content.
1. You can build the documentation [by running the `build` command](https://jupyterbook.org/en/stable/start/build.html):
```bash
jupyter-book build ./
```
2. Preview the built documentation by opening the generated `html` file:
```
_build/html/index.html
```
### Publishing the Documentation
1. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-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.
## 📚 References
Compare the `jupyter-book`:
1. [documentation](https://jupyterbook.org/en/stable/intro.html)
2. [feature requests queue](https://executablebooks.org/en/latest/feature-vote.html)
3. [discussions on GitHub](https://github.com/orgs/executablebooks/discussions)