File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -6,8 +6,9 @@ The documentation follows the [Diataxis approach](https://diataxis.fr/).
66
771 . Create a virtual environment and activate it.
882 . Install the requirements with ` pip install -r requirements.txt ` .
9- 3 . Build the docs locally with ` ./build-docs.sh ` . The new version is available in ` docs/build/html/index.html ` .
10- 4 . When the local version looks good, push your changes. Pushes to main will build and deploy the new version.
9+ 3 . Create a new branch. The main branch is protected so you can't push to it directly.
10+ 4 . Build the docs locally with ` ./build-docs.sh ` . The new version is available in ` docs/build/html/index.html ` .
11+ 5 . When the local version looks good, push your changes and make a pull request. Pushes to main will build and deploy the new version.
1112
1213``` {note}
1314For the notebooks it is necessary to have the required pyAML packages installed in the environment.
You can’t perform that action at this time.
0 commit comments