Skip to content

Commit

Permalink
add better instructions regarding the github action
Browse files Browse the repository at this point in the history
  • Loading branch information
eeholmes committed Aug 20, 2024
1 parent 042d571 commit 8243a65
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions book/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ Everything is here.

### GitHub Action

There is a GitHub Action that should build the book whenever there is a push to the `book` directory. If the Action does not run, then you will need to debug. Click on the Action that did not build and click on the part that had a problem.
There is a GitHub Action that should build the book whenever there is a push to the `book` directory.

Set Pages to use a GitHub Action. If the Action does not run, then you will need to debug. Click on the Action that did not build and click on the part that had a problem.

### Build locally and push to GitHub

Do `pip install ghp-import` if needed. Then build book and push to GitHub. Set Pages to use `gh-pages` branch. These commands are run within the `book` directory.
Do `pip install ghp-import` if needed. Then build book and push to GitHub. Set Pages to use `gh-pages` branch (which is going to disable deploying from the GitHub Action). These commands are run within the `book` directory.

```
cd /book
Expand Down

0 comments on commit 8243a65

Please sign in to comment.