Skip to content

Build RTD in one shot#170

Merged
freakboy3742 merged 9 commits intomainfrom
rtd-one-shot
Feb 27, 2026
Merged

Build RTD in one shot#170
freakboy3742 merged 9 commits intomainfrom
rtd-one-shot

Conversation

@freakboy3742
Copy link
Member

@freakboy3742 freakboy3742 commented Feb 27, 2026

A series of changes to simplify our RTD usage, and resolve issues found during launching the website (see beeware/website#4).

  • Modifies the RTD configuration to not lint, moving linting to a CI task. This is on the basis that we don't need to reverify links as part of a deploy - we only need to verify that they're accurate as part of an initial PR. Linting is now done as a CI task, in parallel with the RTD build
  • Modifies RTD builds to be a single "docs-all". This means that we take responsibility for generating all the languages, in the right directory (i.e., /html/index.html is the English index; /html/de/index.html is German).
  • Modifies the language selector so that en points at the root path.
  • Modifies the language selector so that picking a language goes to the same page on the chosen language.

This means:

  1. We only need a single RTD project for each documentation target, rather than one per language. This massively improves our concurrency problems
  2. We can use versioning if we want to.
  3. We aren't blocked on linting problems on re-deploys
  4. If we choose to show the RTD flyout menu, the RTD configuration will show the version selector if the project has versions - but won't show the language.

For review purposes, I've modified the RTD configuration for docs-tools to not have any translations, and be a "versioned, no languages" configuration. That means docs-tools-fr and docs-tools-de aren't meaningful tests for this PR. Linting fails because the DE and FR sites don't have the same URL structure any more - it's latest/de, not de/latest.

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

Copy link
Collaborator

@kattni kattni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Site build appears to be successful.

@freakboy3742 freakboy3742 merged commit 94d00e0 into main Feb 27, 2026
4 of 6 checks passed
@freakboy3742 freakboy3742 deleted the rtd-one-shot branch February 27, 2026 03:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants