Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions .github/workflows/deploy_jupyterbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,15 @@ jobs:

- name: Build book
run: make book
env:
BASE_URL: /Git-Tutorial

- name: Add .nojekyll
run: touch book/_build/html/.nojekyll

- name: Deploy
uses: JamesIves/github-pages-deploy-action@releases/v3
uses: JamesIves/github-pages-deploy-action@v4
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: book/_build/site # The folder the action should deploy.
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: book/_build/html
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
.PHONY: book
.PHONY: book serve clean

book:
cd book && uv run jupyter book clean --all --yes && uv run jupyter book build --all
cd book && uv run jupyter book build --html

serve:
cd book && uv run jupyter book start

clean:
cd book && uv run jupyter book clean --all --yes
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@ make book

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`.

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.

```bash
make serve
```


## Notes

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.
5 changes: 0 additions & 5 deletions book/content/bibliography.md

This file was deleted.

1 change: 0 additions & 1 deletion book/myst.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ project:
- title: Appendix
children:
- file: content/glossary.md
- file: content/bibliography.md

site:
template: book-theme
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "git-tutorial-book"
version = "0.1.0"
version = "0.1.1"
description = "Build configuration for the PSLmodels Git Tutorial book."
requires-python = ">=3.11"
dependencies = [
Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading