{"id":20028353,"url":"https://github.com/brightway-lca/brightway-documentation","last_synced_at":"2025-05-05T03:32:12.676Z","repository":{"id":63203094,"uuid":"542931270","full_name":"brightway-lca/brightway-documentation","owner":"brightway-lca","description":"📚🌿 readthedocs.org Sphinx Documentation for Brightway","archived":false,"fork":false,"pushed_at":"2025-04-29T08:35:18.000Z","size":8085,"stargazers_count":13,"open_issues_count":7,"forks_count":61,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-29T09:39:24.275Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":"https://docs.brightway.dev","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brightway-lca.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-09-29T05:14:46.000Z","updated_at":"2025-04-29T08:35:21.000Z","dependencies_parsed_at":"2024-01-18T08:24:15.459Z","dependency_job_id":"3b09cc81-de8e-49c6-8906-6df75124ed70","html_url":"https://github.com/brightway-lca/brightway-documentation","commit_stats":{"total_commits":460,"total_committers":8,"mean_commits":57.5,"dds":"0.30869565217391304","last_synced_commit":"d3ae5ccddae326c207c86cb77182e1610ece5e3d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brightway-lca%2Fbrightway-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brightway-lca%2Fbrightway-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brightway-lca%2Fbrightway-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brightway-lca%2Fbrightway-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brightway-lca","download_url":"https://codeload.github.com/brightway-lca/brightway-documentation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252435090,"owners_count":21747343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation"],"created_at":"2024-11-13T09:14:20.998Z","updated_at":"2025-05-05T03:32:11.870Z","avatar_url":"https://github.com/brightway-lca.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brightway Documentation (Sphinx/readthedocs.org)\n\n✨ The Brightway Documentation page is a [PyData Sphinx __featured site__](https://pydata-sphinx-theme.readthedocs.io/en/latest/examples/gallery.html) (since [01.2024](https://github.com/pydata/pydata-sphinx-theme/pull/1580)) ✨\n\n[![Brightway](https://img.shields.io/static/v1?label=Brightway\u0026message=ecosystem\u0026color=45bfb0\u0026logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTA2NSIgaGVpZ2h0PSI2OTAiIHZlcnNpb249IjEuMSIgdmlld0JveD0iMCAwIDEwNjUgNjkwIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogPGRlZnM+CiAgPGNsaXBQYXRoIGlkPSJjbGlwUGF0aDIxNzMiPgogICA8cGF0aCBkPSJtLTU5NSA0NDBoMWUzdi0xZTNoLTFlM3oiLz4KICA8L2NsaXBQYXRoPgogPC9kZWZzPgogPGcgdHJhbnNmb3JtPSJtYXRyaXgoMS4zIDAgMCAtMS4zIDY1MyA0MDMpIiBjbGlwLXBhdGg9InVybCgjY2xpcFBhdGgyMTczKSIgZmlsbD0iI2ZmZiI+CiAgPHBhdGggZD0ibTAgMGMwLTEuMi0xLjUtMy40LTAuNDctNS4yIDEuMy0yLjQgNS40LTEuNSA1LjgtM3YtMC4wMThsLTQuNy0wLjA1NC0yLTQuMWMtMS45IDAuNzEtMi40IDMuMi0zLjIgNi42LTAuNDQgMi0wLjcxIDMuNCAwLjA4OSA0LjctMTQtMy4zLTMwLTUuNC00NS01LjQtNDkgMC4wMzYtNzEgMTctMTA3IDI0IDEuNS0xLjEgMi43LTMuMyAyLjEtNC45bC02LjEgMi4yLTQtMy4xYy0xLjQgMS40LTAuNTggMi44LTIuMiA0LjgtMi4xIDIuNS01LjMgMi42LTUuMiAzIDAuODctMC4wNzIgMS43LTAuMTQgMi42LTAuMjItMS42IDAuMjQtMi41IDAuNC0yLjYgMC4yMi0zLjkgMC4zMS04IDAuNDktMTIgMC41MS02NiAwLjIyLTEwMi00Mi0xMjItNzkgMy42IDIuOSA4LjcgMS41IDEwIDEuMSA0LjItMS4xIDguOC00LjEgOC40LTYuMWwtNC41LTEuNSAwLjUyLTAuNTRjLTAuMjItMC4wMTktMC40My0wLjAxOS0wLjY1LTAuMDE5LTQuMiAwLjA1NS01LjEgMy45LTkuMiA0LjItMy44IDAuMjktNi40LTIuNy03LjItMS45LTEzLTI3LTE4LTUwLTE4LTUwaC0zNHM2LjcgMzQgMzAgNjhjLTEuNiAxIDEgNS0xLjEgOC4zLTIuNSAzLjgtOC40IDIuNC04LjggNC41LTAuMDE4IDAuMTMtMC4wMzYgMC4yNSAwIDAuMzhsNy4yLTAuNTIgMi41IDUuNWMxLjEtMC40IDItMS43IDMuOS00LjIgMS40LTEuOCAyLjQtMy4yIDMuMS00LjMgMjYgMzQgNjkgNjcgMTM5IDY3IDIuNSAwIDUtMC4wNzMgNy40LTAuMi0wLjU4IDIuMSA1IDMuNSA1LjcgOC4xIDAuNzQgNC44LTQuNyA3LjgtMy40IDEwIDAuMDE4IDAuMDE4IDAuMDM2IDAuMDU0IDAuMDU0IDAuMDcybDUuOC00LjQgNC43IDMuMWMwLjU2LTAuODcgMC42My0xLjctMC40NS04LTEuNC04LjItMS45LTktMi43LTkuNyA0MS01LjIgNjgtMjggMTE4LTI5IDE1LTAuNTQgMzAgMC43OCA0NCAzLjEtMC4yNyAwLjE2LTAuNTIgMC4zNi0wLjc2IDAuNjItMSAxLjEtMS4xIDMuMS0xLjQgNy4xLTAuMjUgNC4zLTAuNCA2LjYgMC40MiA3LjdsMi44LTMuMiAzLjIgMS4yYzAuMDM2LTAuMDcyIDAuMDU0LTAuMTYgMC4wNzItMC4yNCAwLjQ0LTEuOC0xLjEtMi43LTEuMS01LjYgMC0zLjUgMi4zLTQuOSAxLjgtNi41LTAuMDM2LTAuMDktMC4wNzItMC4xOC0wLjExLTAuMjUgNDUgOC43IDc4IDI4IDc5IDI4IDAtMC42My0zNS0yMi03OS0zM20tMzMyLTMwLTU1IDQuMS0zNSA0MC0xNyAyOC0xNSAyNC05LjcgMjctMjYgMTYgMzgtOS40IDM5LTI0IDMxLTI4IDI3LTM5IDE5LTMzem00MTEgNjUgMTEgNzkgNTcgNDYgNjggOS4zIDQ1LTAuMzkgNDcgMTYtMTYtMzYtMTMtMzQtMjQtNTgtMzItNDktMzktMjAtNDMgMy43em04OC0yNDktMTggMzItMjEgMjYtMzUgMzQtMjEgMjYtMjAgMjItMzcgNDgtMTcgMjAgNzAgMC44NyA1Ni00OSAyMi00MCAxNS0zNyAyLjgtMzJ6bTAgMC0xNyAxNy0zOSA2LjItNDQgMTMtNTAgMzMtMzAgNTUtMy4zIDUzIDEzIDI3IDEuOSAzLjcgMTctMjAgMzctNDggMjAtMjIgMjEtMjYgMzUtMzQgMjEtMjZ6bS05MSAzNDgtMTYtNTctMzEtNDYtMzMtMTIgMC4xNSAzLjkgMS42IDQ0IDQuNCAzNiA1LjEgMzQgNC4zIDQwIDIgMzQgMi4zIDM2IDEzIDQyIDQuNS0zNyAxNi0yMiAyMC0zN3ptLTQ3IDE1NC0xMy00Mi0yLjMtMzYtMi0zNC00LjMtNDAtNS4xLTM0LTQuNC0zNi0xLjYtNDQtMC4xNS0zLjktMi44IDMuMi00OCA1NS03LjIgMzcgMC43OCA2NCAyNiA0OCAzMyAyOXptLTE0NS0zOTktMjAgNDMtMTIgNDEtNi4xIDI0LTYuNyAyMCA1OC0yMSAxNS0yNiAxNi00NC00LjItMzctMTItNjEtNS4yIDI0em0yOC02MS0yNyAxOS0yMCAxMS0yOCAyMC0zMSAzMC02LjggNDggMTcgNDIgMjQgMTggMS41LTQuNiA1LjItMTYgNi4xLTI0IDEyLTQxIDIwLTQzIDIyLTM3em0tMTEgMzA1LTE4LTUxLTUyLTM0LTAuMjUgNS44LTAuODMgMTkgMS4yIDM5LTMuMSA0My02LjcgMzgtMTEgNDYtMTUgNjMgMjAtMjUgNDMtNDEgMzAtNDl6bS03MC03OSAwLjI1LTUuOC01NiA0Mi0xNyA2NSAyLjcgNTAgOS40IDQwIDE2IDE3IDguNCA0MCAxNS02MyAxMS00NiA2LjctMzggMy4xLTQzLTEuMi0zOXptLTU0LTE5NC0xMiAyMC0yMiAyNi0xOCAxNS0xNyAxNy0wLjEzLTAuNTYtOS43LTQ1IDIxLTM0IDIzLTEzIDIxLTguMiAzNy0xOS0xNSAxM3ptMjQtNDEtMTUgMTMtOC4zIDI4LTEyIDIwLTIyIDI2LTE4IDE1LTE3IDE3IDQyIDE0IDI0LTQuOCAxNS0xNiA4LjYtMzMgMS41LTI4LTMuNC0yMHptLTExMCAyMDItMjMtNTEtMi44IDQuOS0xOSAzMy0yNyAzOS0zMSAyOC0zOSAyNC0zOCA5LjQgMzIgMS4zIDMxIDEuNiAzMC0wLjI5IDQzLTE2IDMwLTMweiIvPgogPC9nPgo8L3N2Zz4K)](https://github.com/brightway-lca)\n![License](https://img.shields.io/github/license/brightway-lca/brightway-documentation?color=green\u0026logo=Open%20Source%20Initiative\u0026logoColor=white) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat\u0026logo=GitHub)](https://github.com/brightway-lca/brightway-documentation-readthedocs/discussions) \\\nMaintainance Team : [@michaelweinold](https://github.com/michaelweinold), [@cmutel](https://github.com/cmutel), [@tngTUDOR](https://github.com/tngTUDOR)\n\nThe primary documentation for the Brightway life-cycle assessment software package. Sphinx and readthedocs.org are used to build/host the documentation.\n\n| static documentation | interactive documentation | development playground  |\n| ---- | ------------- | ------------- |\n| [docs.brightway.dev](https://github.com/brightway-lca/brightway-documentation) | [learn.brightway.dev](https://github.com/brightway-lca/brightway-learn) | [live.brightway.dev](https://github.com/brightway-lca/brightway-live) | \n\n## Overview\n\n### Repository Structure\n\nThe content of the Brightway documentation is stored in the `source/content` folder of the `brightway-documentation` repository. The homepage is located in `source/content/index.md`. The `source/conf.py` file contains the configuration for the documentation build.\n\nBrightway modules are split up into different repositories for strategic reasons (`brightway-2-analyzer`, `brightway2-calc`, etc.). These repositories are included as [`git submodules`](https://git-scm.com/book/en/v2/Git-Tools-Submodules) in this repository. This allows the Sphinx documentation generator to easily to build a combined changelog page or generate an API documentation from Brightway source code.\n\n```\n.\n├── environment.yml\n├── source/\n│   ├── conf.py\n|   ├── index.md\n│   └── content/\n│       ├── setup/\n│       ├── introduction/\n│       └── (...other documentation sections)\n├── README.md\n├── brightway2-io/ (git submodule)\n├── brightway2-data/ (git submodule)\n└── (...other Brightway modules as git submodules)\n```\n\n### Sphinx\n\nThe Brightway documentation is built with [Sphinx](https://www.sphinx-doc.org/en/master/), the Python documentation generator. All relevant code resides in the [`brightway-documentation`](https://github.com/brightway-lca/brightway-documentation) repository.\n\n### readthedocs.org\n\nThe documentation is hosted on [readthedocs.org](https://readthedocs.org/). The build is triggered automatically every time the `main` branch of the `brightway-documentation` repository is updated. The build process is currently ![Read the Docs](https://img.shields.io/readthedocs/brightway-documentation?label=readthedocs.org\u0026logo=Read%20the%20Docs\u0026logoColor=white).\n\n\nThree users are currently assigned as administrators: [`@cmutel`](https://github.com/cmutel), [`@michaelweinold`](https://github.com/michaelweinold) and [`@tngTUDOR`](https://github.com/tngTUDOR).\n\n### git submodules\n\nThe core functionality of Brightway is provided by different packages (e.g. `brightway-calc`, `brightway-data`). For strategic reasons, these packages are maintained as separate repositories. The content of these repositories is included in the `brightway-documentation` repository through [`git submodules`](https://git-scm.com/book/en/v2/Git-Tools-Submodules). This enables `sphinx` to include files from these repositories in the documentation directly (e.g. `README.md`). It further enables `sphinx-autodoc` both locally and in the readthedocs.org service to build the API documentation from source instead of importing all Brightway packages during the build process. \n\n## Quickstart\n\n### Setup Repository\n\n1. Clone this repository:\n\n```bash\ngit clone https://github.com/brightway-lca/brightway-documentation.git\n```\n\n2. Initialize (=download) the submodules (`brightway-2-analyzer`, `brightway2-calc`, etc.):\n\n```bash\ngit submodule update --init --recursive --remote --force\n```\n\n| option | description |\n| ---------------------------- | ----------- |\n| init | initializes (=downloads) submodules if not currently present |\n| recursive | goes through all submodules specified in the `.gitmodules` file |\n| remote | points to the latest commit on the branches specified in the `.gitmodules` file |\n| force | ensures that accidental edits in the submodules are always overwritten |\n\nNote that if the `--remote` flag is not set, the submodules will point to the latest commit on the default branches (`main`), **not** to the latest commit on the branches specified in the `.gitmodules` file. On the `main` branch of the `brightway-documentation` repo, all submodule branches specified in the `.gitmodules` should be `main`. This is to ensure the documentation is always up-to-date with the latest changes in the submodules.\n\nTo manually update the submodules, use the same command again. There is no need to push changes to the submodules to the remote, since [they are updated by GitHub Actions](https://documentation.brightway.dev/en/latest/source/contributing/documentation.html#github-actions).\n\n### Setup Python Environment\n\nSet 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 `sphinx` by running from the repository root directory:\n\n```bash\nconda env create -f 'environment.yml'\n```\n\nand activate the environment:\n\n```bash\nconda activate sphinx\n```\n\nYou are now ready to build the documentation...\n\n### Building the Documentation\n\n1. You can build the documentation by __triggering every build manually__: To trigger the build, run [`sphinx-build`](https://www.sphinx-doc.org/en/master/man/sphinx-build.html) from the repository root directory:\n\n```bash\nsphinx-build source _build/html --builder=singlehtml --jobs=auto --write-all; open _build/html/index.html\n```\n\n| option | value | description |\n| ---------------------------- | ----- | ----------- |\n| sourcedir | `source` | N/A |\n| outdir | `_build/html` | N/A |\n| `--builder` | `html` | [default builder](https://www.sphinx-doc.org/en/master/usage/builders/index.html) |\n| `--write-all` | N/A | always write all output files |\n| `--jobs` | `auto` | [speed up build by using multiple processes](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-j) |\n\n\nYour browser should automatically open. You can also open the build manually, stored as a single html page at:\n\n```\n_build/html/homepage.html\n```\n\n2. You can also build the documentation by automatically triggering a build after every change to the source files, providing a \"live\" preview of changes. To trigger the automated builds, run [`sphinx-autobuild`](https://github.com/executablebooks/sphinx-autobuild) from the repository root directory:\n\n```bash\nsphinx-autobuild source _build/html -a -j auto --ignore source/content/api* --open-browser\n```\n\n| positional argument or option| value | description |\n| ---------------------------- | ----- | ----------- |\n| sourcedir | `source` | N/A |\n| outdir | `_build/html` | N/A |\n| `-a` | N/A | always write all output files |\n| `-j` | `auto` | [speed up build by using multiple processes](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-j) |\n| `--ignore` | `source/content/api*` | ignores API documentation generated with sphinx-autoapi to avoid infinite build loops |\n| `--open-browser` | N/A | automatically open browser |\n\n\nYou can now preview the documentation at (the browser window will open automatically ✨):\nhttp://127.0.0.1:8000/\n\n\n### Contributing\n\nPlease follow the extensive guide we have provided [on the documentation website](https://documentation.brightway.dev/en/latest/source/contributing/contributing.html).\n\n## Manual\n\n### Updating the Build Environment\n\nThe build environment (packages and versions used by Sphinx to build the documentation) is defined in the [Conda environment file](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment) [`./environment.yml`](environment.yml). \n\nPackage versions are \"pinned\" to ensure that the documentation is always built with the same versions. Otherwise, changes in one of the packages might break the build. Package versions are _not_ updated automatiaclly. In doing so, we are following [the recommendation by the community](https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/index.html#user-guide):\n\n\u003e \\[The pydata-sphinx-theme\\] is still under active development, and we make no promises about the stability of any specific HTML structure, CSS variables, etc. Make these customizations at your own risk, and pin versions if you’re worried about breaking changes!\n\n To update the package versions, edit the file and test the build locally, before pushing the changes to the remote.\n\n### Updating Git Submodules\n\nWhat if you want to update the [docstrings](https://en.wikipedia.org/wiki/Docstring) of a Brightway package (eg. `bw2data`) and check if they render correctly in the documentation? You can do this by updating the submodule `brightway2-data` and building the documentation:\n\n1. Use the [`git submodule set-url`](https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt-set-url--ltpathgtltnewurlgt) command to update the URL of the submodule:\n\n\u003e [!NOTE]\n\u003e Replace `brightway2-data` with the name of the submodule you want to update. \\\n\u003e Replace `https://github.com/(...))` with the URL of the submodule you want to update.\n\n```bash\ngit submodule set-url brightway2-data https://github.com/michaelweinold/brightway2-data\n```\n\nThis will update the URL in the `.gitmodules` file and in the `.git/config` file:\n\n```\n[submodule \"brightway2-data\"]\n\tpath = brightway2-data\n\turl = https://github.com/michaelweinold/brightway2-data\n\tbranch = main\n```\n\n2. Use the [`git submodule update`](https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt-update--init--remote-N--no-fetch--no-recommend-shallow-f--force--checkout--rebase--merge--referenceltrepositorygt--depthltdepthgt--recursive--jobsltngt--no-single-branch--filterltfilterspecgt--ltpathgt82308203) command to update the submodule:\n\n```bash\ngit submodule update --init --recursive --remote\n```\n\n3. Now build the documentation as described above.\n4. To change the URL of the submodule back to the original URL, repeat step 1. with the original URL.\n\n### Updating the Example Gallery\n\nExamples are collected in the form of Jupyter Notebooks in the [`brightway-examples`](https://github.com/brightway-lca/brightway-examples) repository. This repository is included as a submodule in this repository at [`.source/content/examples/brightway-examples`](.source/content/examples/brightway-examples).\n\nWhen new examples are added to the \n\nTo update the submodule, follow the steps described in [Updating Git Submodules](#updating-git-submodules).\n\n### Checking for Dead External Links\n\nThe documentation contains links to external websites. To check if these links are still valid, run the following command from the repository root directory:\n\n```bash\nsphinx-build -b linkcheck -D linkcheck_workers=20 source _build/linkcheck\n```\n\n| positional argument or option| value | description |\n| ---------------------------- | ----- | ----------- |\n| `-b` | `linkcheck` | [`linkcheck` builder](https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder) |\n| `-D` | `linkcheck_workers=20`` | [number of links to check in paralell](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_workers) |\n| sourcedir | `source` | N/A |\n| outdir | `_build/linkcheck` | `_build/linkcheck/output.txt` contains a list of all broken or redirected links |\n\nInternal links, if formatted according to [the `myst-parser` cross-referencing specifications](https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#cross-references), are checked automatically during the regular build process.\n\n## GitHub Actions\n\nThe [`git submodules`](./.gitmodules) in the `brightway-documentation` repo are automatically updated every time the source repositories (eg. `brightway2-data`) are updated. Since the readthedocs.org build is then triggered, the API documentation is automatically updated every time that new code is added to a Brightway library. This is accomplished by three [GitHub Action workflows](https://github.com/features/actions):\n\n[![Update Submodules](https://github.com/brightway-lca/brightway-documentation/actions/workflows/update_submodules.yml/badge.svg)](https://github.com/brightway-lca/brightway-documentation/actions/workflows/update_submodules.yml) \\\n[![Create Workflow Dispatch (Trigger Submodule Update)](https://github.com/brightway-lca/brightway-documentation/actions/workflows/trigger_submodule_update_main.yml/badge.svg)](https://github.com/brightway-lca/brightway-documentation/actions/workflows/trigger_submodule_update_main.yml) \\\n[![Re-Use Workflow - Create Workflow Dispatch (Trigger Submodule Update)](https://github.com/brightway-lca/brightway-documentation/actions/workflows/trigger_submodule_update_reuse.yml/badge.svg)](https://github.com/brightway-lca/brightway-documentation/actions/workflows/trigger_submodule_update_reuse.yml)\n\nand a [GitHub App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps) to ensure the workflows have the necessary permissions to update the submodules. The actions are connected as follows:\n\n```mermaid\n  flowchart TD;\n    id1([\u003ctt\u003ebw2data\u003c/tt\u003e updated])\n\t--\u003e \n\tid2(\u003ctt\u003ebw2data\u003c/tt\u003e Action: \u003ca href='https://github.com/brightway-lca/brightway2-data/blob/main/.github/workflows/trigger_submodule_update_reuse.yml'\u003eRe-Use Workflow\u003c/a\u003e)\n\t--\u003e\n\tid3(\u003ctt\u003ebw2data\u003c/tt\u003e Action: \u003ca href='https://github.com/brightway-lca/brightway-documentation/blob/main/.github/workflows/trigger_submodule_update_main.yml'\u003eTrigger 'Update Submodules'\u003c/a\u003e) \n\t--\u003e \n\tid4(\u003ctt\u003ebrightway-documentation\u003c/tt\u003e Action: \u003ca href='https://github.com/brightway-lca/brightway-documentation/blob/main/.github/workflows/update_submodules.yml'\u003eUpdate Submodules\u003c/a\u003e)\n\t--\u003e \n\tid5([\u003ctt\u003ebw2data\u003c/tt\u003e submodule in \u003ctt\u003ebrightway-documentation\u003c/tt\u003e updated])\n\tid7(\u003ca href='https://github.com/organizations/brightway-lca/settings/installations/40187447'\u003e\u003ctt\u003eDocumentation Workflow App\u003c/tt\u003e\u003c/a\u003e)-- permissions to trigger run --\u003eid3\n```\n\n## 📚 References\n\nCompare the `sphinx`:\n\n1. [documentation](https://www.sphinx-doc.org/en/master/)\n2. [getting started (from readthedocs)](https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html)\n3. [issues on GitHub](https://github.com/sphinx-doc/sphinx/issues)\n\nCompare the `readthedocs.org`:\n\n1. [documentation](https://docs.readthedocs.io/en/stable/index.html)\n2. [tutorial](https://docs.readthedocs.io/en/stable/tutorial/)\n3. [issues on GitHub](https://github.com/readthedocs/readthedocs.org/issues)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrightway-lca%2Fbrightway-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrightway-lca%2Fbrightway-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrightway-lca%2Fbrightway-documentation/lists"}