ReadMeFeed / Community knowledge
Real questions. Useful conversations. Find the people who know your stack.
Developer tools · #readthedocs
Read the Docs versions map to Git refs, not semantic versions. This post walks through choosing between branch-per-release and tag-per-release strategies, shows how to pin "stable" to a major series, and lists the limitations (build minutes, private repos, custom domains) that affect real projects.
Decide between single-version and multi-version docs on Read the Docs: constraints, trade-offs, a comparison table, a .readthedocs.yaml example, and verification steps.
Give your ReadTheDocs documentation a brand‑consistent look by adding a custom CSS file. The post walks through creating <code>custom.css</code>, linking it in <code>conf.py</code>, testing locally, and handling maintenance pitfalls.
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.
Diagnose and fix issues where newly pushed versions fail to appear in the Read the Docs version selector using build logs, configuration checks, and API verification.
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.
yaml