ReadMeFeed / Community knowledge
Real questions. Useful conversations. Find the people who know your stack.
Learn how to let Read the Docs automatically build and serve each Git tag or branch as a separate documentation version using a simple .readthedocs.yaml file. Follow the step‑by‑step guide, example config, and common pitfalls to get versioned docs up and running quickly.
Stop documentation drift by using Read the Docs' versioning and flyout menu. Learn how to map git tags to hosted versions to support multiple software releases simultaneously.
Pin your Read the Docs build environment, dependencies, and PDF output with a .readthedocs.yaml file — including a working example, LaTeX pitfalls, and the platform limits you cannot configure away.
Read the Docs can build a rendered preview of your documentation for every pull request. Here's how the feature works, how to enable it, and the trade-offs to know before you rely on it.
Read the Docs builds a separate docs site per Git tag or branch. Here's how version switching works, why tag naming discipline matters, and how to add a maintenance-branch version safely.
ReadTheDocs now builds a preview of your documentation for every pull request. Learn how to enable, use, and test these builds, and understand the trade‑offs before merging.
Learn how to pick the default version in Read the Docs so visitors see the right docs for stable releases while developers can still access the latest build.
ReadTheDocs build failing with YAML errors, ModuleNotFoundError, or missing artifacts? A diagnostic table, ordered checks, and a pinned reference config to isolate the cause fast.
Pin the build environment in readthedocs.yml and map repository tags to Read the Docs versions to keep documentation reproducible and aligned with releases.
readthedocs
yaml