diff --git a/.github/workflows/deploy_jupyterbook.yml b/.github/workflows/deploy_jupyterbook.yml index 485ccba..2f7e852 100644 --- a/.github/workflows/deploy_jupyterbook.yml +++ b/.github/workflows/deploy_jupyterbook.yml @@ -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 diff --git a/Makefile b/Makefile index 6f5b381..f805482 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/README.md b/README.md index d9d5ea2..f1a506b 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/book/content/bibliography.md b/book/content/bibliography.md deleted file mode 100644 index cbbbfd1..0000000 --- a/book/content/bibliography.md +++ /dev/null @@ -1,5 +0,0 @@ -(chap_bibliog)= -# Bibliography - -:::{bibliography} -::: diff --git a/book/myst.yml b/book/myst.yml index 0166b71..7879c25 100644 --- a/book/myst.yml +++ b/book/myst.yml @@ -42,7 +42,6 @@ project: - title: Appendix children: - file: content/glossary.md - - file: content/bibliography.md site: template: book-theme diff --git a/pyproject.toml b/pyproject.toml index 7315478..901f01d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 = [ diff --git a/uv.lock b/uv.lock index e0aa83c..50b3a3d 100644 --- a/uv.lock +++ b/uv.lock @@ -292,7 +292,7 @@ wheels = [ [[package]] name = "git-tutorial-book" -version = "0.1.0" +version = "0.1.1" source = { virtual = "." } dependencies = [ { name = "jupyter-book" },