admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

note build commands

Browse source
This commit is contained in:
Robert Lanzafame 2025-04-05 06:12:07 +02:00 • committed by GitHub
parent 4dfffb1206
commit b3183b8e85
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
book/features/overview.md
View file

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