Skip to content

Commit 020e716

Browse files
Revise README instructions for doc building and PRs
Updated instructions for building docs and pushing changes.
1 parent 55dc755 commit 020e716

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ The documentation follows the [Diataxis approach](https://diataxis.fr/).
66

77
1. Create a virtual environment and activate it.
88
2. 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}
1314
For the notebooks it is necessary to have the required pyAML packages installed in the environment.

0 commit comments

Comments
 (0)