From b3183b8e858ad338438a0c503bd5b481948186c0 Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Sat, 5 Apr 2025 06:12:07 +0200 Subject: [PATCH] note build commands --- book/features/overview.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/book/features/overview.md b/book/features/overview.md index 3b442fb..49c62c5 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -48,6 +48,8 @@ For those who wish to use the package, it is available on [PyPI](https://pypi.or teachbooks build book ``` +This Manual describes the main features and usage of the package. For those who wish to understand more of hte technical details, note that the implementation the API is is documented at [teachbooks.readthedocs.io/](https://teachbooks.readthedocs.io/). + ### List of Features Items in the list here are currently implemented in the TeachBooks package and described on other pages of this manual: @@ -75,6 +77,18 @@ Important for these features: - [](./pull_request_build.md): created to provide DBW-like behavior for PR's from forked repositories - [](./apa.md): a temporary fix is included in `teachbooks` to enable use in the DBW +### Book Build Commands + +By default the DBW builds books using the following command: +``` +teachbooks build book/ +``` + +To use the [Draft-Release Workflow](./draft-release.md) with the Deploy Book Workflow the `BRANCHES_TO_PREPROCESS` variable must be configured for a specific branch, which will then execute the following command: +``` +teachbooks build --release book/ +``` + ### Environmnets and Caching As described on the [DBW page](../external/deploy-book-workflow/README.md), there is a lot going on "under the hood" with regards to caching of GitHub Action artifacts. This can lead to undesired behavior when using the DBW, especially if package version numbers are not precisely defined. In general we expect the risk of this occurring to be low, as it should only happen when multiple branches are being actively used (new commits on each branch at least once per week), a package from the `requirements.txt` file is updated in the time between creation of two or more branches, and that package _also_ has a significant impact on the book building process. As the Python virtual environment cache is replaced by default if older than one week, the issue should resolve itself within that time frame.