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

Add more recommended settings

Browse source
This commit is contained in:
Tom van Woudenberg 2025-02-17 07:41:41 +01:00 • committed by GitHub
parent 392780a425
commit e5259fdeb6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

15
book/features/pull_request_build.md
View file

@ -67,4 +67,17 @@ On your [dashboard](https://app.readthedocs.org/dashboard/), add a new project.
### Enable Pull Request build
In the setting of your newest project, enable build of pull request by selecting the option in `Building - Pull request builds - Build pull requests for this project`.
In the setting of your newest project, enable build of pull request by selecting the option in `Building - Pull request builds - Build pull requests for this project`.
### Additional settings
The following settings are recommended:
- `Setup` - `Settings` - `URL versioning scheme` - `Multiple versions without translations (/<version>/<filename>)`, as translated books can be implemented with [](../external/Sphinx-launch-buttons/README.md)
- `Setup` - `Settings` - `Addons` - `Search` - disabled, as your books already contain a search function and the Read the Docs search functions requires [additional setup](https://docs.readthedocs.com/platform/stable/intro/sphinx.html#configure-read-the-docs-search)
- `Setup` - `Settings` - `Addons` - `Link previews` - disabled, `Multiple versions without translations (/<version>/<filename>)`, as previews can be implemented with [](../external/teachbooks-sphinx-tippy/README.md)
- `Setup` - `Settings` - `Automation rules` - `Add rule`, to build all tagged versions of your book:
- `Description`: 'Build all tags'
- `Match`: `Custom Match`
- `Custom match`: `.*`
- `Version type`: `Tag`
- `Action`: `Activate version`