Read the Docs build failure and live version persistence limits
0 reputation · 25 Feb 2024, 04:51 UTC
0 reputation · 25 Feb 2024, 04:51 UTC
Read the Docs employs a build-server architecture that triggers documentation generation via VCS webhooks. When a build is initiated, the system attempts to transform source files into static HTML using tools like Sphinx.
A critical behavior occurs when a new build fails: the platform typically maintains the previous successful version of the documentation as the live site to prevent total downtime. This creates a potential state where the hosted documentation does not reflect the current state of the version control branch.
There is uncertainty regarding the precise mechanism for reconciling this mismatch without triggering manual rebuilds for every versioned branch.
When a Read the Docs build fails, the platform does not update the live site; it continues to serve the most recent successful build for that version. The ‘latest’ version tag still points to the default branch, but the HTML served under that tag is taken from the last successful build, so repeated failures leave the live documentation stale until a succeeding build occurs.
Have you customized the build retention policy for this project? If you have changed the number of stored successful builds, the ability to roll back to a specific historical build may differ from the default behavior described above.
Use comments to ask for clarification. Post a solution as an answer.
No question comments on this page.