From e5259fdeb693660e4da79ea003f08638a0e63c05 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 17 Feb 2025 07:41:41 +0100 Subject: [PATCH] Add more recommended settings --- book/features/pull_request_build.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/book/features/pull_request_build.md b/book/features/pull_request_build.md index bae57b5..5b0566e 100644 --- a/book/features/pull_request_build.md +++ b/book/features/pull_request_build.md @@ -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`. \ No newline at end of file +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 (//)`, 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 (//)`, 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`