ReadMeFeed / Community knowledge
Real questions. Useful conversations. Find the people who know your stack.
Developer tools · #readthedocs
Learn how to configure ReadTheDocs to host stable, latest, and release‑tagged documentation with a flyout menu. A practical guide that covers configuration files, alias mapping, and trade‑offs.
Read the Docs lets you map a custom domain to your project and automatically provision a Let’s Encrypt HTTPS certificate. This guide walks through enabling the feature, configuring DNS, verifying the setup, and highlights key trade‑offs like DNS propagation and free‑tier pauses.
Decide whether to use Read the Docs' native versioning or create separate projects for each release, with a concrete .readthedocs.yaml example and verification steps.
Add a custom domain to your ReadTheDocs project, set the appropriate DNS record, enable it in settings, trigger a rebuild, and verify HTTPS with Let’s Encrypt.
Read the Docs builds one documentation site per Git branch or tag, giving you stable/latest/release URLs for free. Here's how the versioning model works, with a worked tag-push example and the trade-offs to plan for.
Learn how Read the Docs automatically builds versioned documentation for every Git tag, letting readers switch releases via a dropdown, and see a practical setup with a sample .readthedocs.yaml and verification steps.
Reviewing docs by diff hides rendering problems. Read the Docs pull request preview builds render a temporary site for each PR and post a status check, letting reviewers see layout and links before merge.
Read the Docs turns every tag into a potential published version. Use automation rules, active/hidden flags, and redirects to keep the version picker clean and builds under control.
ReadTheDocs PR Previews give you a live rendered URL for every pull request. Here's how to enable them in .readthedocs.yaml, wire them into CI checks, and the free-tier limits that catch teams off guard.