Which site best fits your project?
Free for open-source software.
Sign upPlans starting at $50/month.
Sign upWhich site best fits your project?
Free for open-source software.
Sign upPlans starting at $50/month.
Sign upEmpower your team with versioned documentation, seamless previews, and powerful authentication. All integrated into your Git workflow.
Get started for free Explore features
See exactly what changed in the rendered documentation, not just the source.
Write documentation with Git and your favorite text editor. Developers and writers both love docs as code.
Share content with just your team, or with the whole world. Sync permissions from GitHub, or manage custom permissions for your projects.
Integrated support for Sphinx, MkDocs, Jupyter Book, Docusaurus, and more. Flexible enough to work with any documentation tool.
Easily search all your docs via our dashboard, and offer your users a more powerful search with our search API.
See the rendered diff and files changed, posted in every GitHub and GitLab pull request.
Match your product release cycle with multiple versions of your docs. Automatically build versions from any branch or tag.
Clone private repositories using a connected GitHub, GitLab, or Bitbucket account, or clone from any Git provider with an SSH key.
Control who has access to your documentation with integrated authentication. Enable SSO with GitHub or GitLab to easily manage permissions in one place.
.readthedocs.yaml
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.10"
# You can also specify other tool versions:
# nodejs: "16"
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
# Dependencies required to build your docs
python:
install:
- requirements: docs/requirements.txt
Read the Docs plays a large part in enabling a small volunteer team to maintain our docs. Without the generous Community plan, we couldn't have afforded anything close to the CI/build resources that we got with Read the Docs.
Read the Docs is a critical component of the open source software ecosystem. And their PR builds are the best and most trustworthy implementation out there.
Get your docs online in 5 minutes.