ReadMeFeed / Community knowledge
Real questions. Useful conversations. Find the people who know your stack.
Developer tools · #readthedocs
Learn how Read the Docs pull‑request preview builds let you review rendered documentation instead of relying on raw diffs, with a concrete setup example, trade‑offs, and cleanup tips.
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.
Read the Docs automatically builds documentation from Git repositories when code is pushed, supporting multiple versions simultaneously. Learn how to set it up and the trade-offs involved.
Pin the build environment in readthedocs.yml and map repository tags to Read the Docs versions to keep documentation reproducible and aligned with releases.
Learn how to add a custom domain to your ReadTheDocs project, configure DNS, update Sphinx, and verify the SSL certificate. Follow this step‑by‑step guide to ensure your docs load securely on your own domain.
Learn how to automatically publish documentation for each Git tag using Read the Docs, see a step‑by‑step example, and understand the trade‑offs of keeping many versions active.
Learn how to serve Read the Docs documentation on your own domain with HTTPS using only a CNAME record and RTFD’s automatic Let’s Encrypt integration.
git