Skip to content

Commit 26567ad

Browse files
authored
Merge pull request #37 from rickecon/rick_upd
Merging
2 parents 3d4ca15 + d8f5e0f commit 26567ad

7 files changed

Lines changed: 26 additions & 14 deletions

File tree

.github/workflows/deploy_jupyterbook.yml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,15 @@ jobs:
2424

2525
- name: Build book
2626
run: make book
27+
env:
28+
BASE_URL: /Git-Tutorial
29+
30+
- name: Add .nojekyll
31+
run: touch book/_build/html/.nojekyll
2732

2833
- name: Deploy
29-
uses: JamesIves/github-pages-deploy-action@releases/v3
34+
uses: JamesIves/github-pages-deploy-action@v4
3035
with:
31-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
32-
BRANCH: gh-pages # The branch the action should deploy to.
33-
FOLDER: book/_build/site # The folder the action should deploy.
36+
token: ${{ secrets.GITHUB_TOKEN }}
37+
branch: gh-pages
38+
folder: book/_build/html

Makefile

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
.PHONY: book
1+
.PHONY: book serve clean
22

33
book:
4-
cd book && uv run jupyter book clean --all --yes && uv run jupyter book build --all
4+
cd book && uv run jupyter book build --html
5+
6+
serve:
7+
cd book && uv run jupyter book start
8+
9+
clean:
10+
cd book && uv run jupyter book clean --all --yes

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ make book
3232

3333
The `book` target first removes the existing Jupyter Book build artifacts and then performs a fresh site build using `uv run jupyter book build --all`.
3434

35+
You can run the `make serve` command to do all the steps from `make book`, but further initiate a local server on which you can view, check, and validate the functioning web site.
36+
37+
```bash
38+
make serve
39+
```
40+
41+
3542
## Notes
3643

3744
This repository is actively maintained and contributions are welcome. The most helpful contributions usually improve tutorial clarity, correct command examples, add beginner-friendly explanations, or expand the hands-on workflow chapters.

book/content/bibliography.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

book/myst.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ project:
4242
- title: Appendix
4343
children:
4444
- file: content/glossary.md
45-
- file: content/bibliography.md
4645

4746
site:
4847
template: book-theme

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "git-tutorial-book"
3-
version = "0.1.0"
3+
version = "0.1.1"
44
description = "Build configuration for the PSLmodels Git Tutorial book."
55
requires-python = ">=3.11"
66
dependencies = [

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)