How automatic documentation deployment works
Automate the deployment of your technical documentation by building your project with every change to your documentation source. Maintain your documentation without managing extra services. Building, hosting, CDN, authentication, and search are all included.
Maintain docs as code
Manage software documentation using all of the same tools and workflow you’re already using for development. Write docs with your favorite editor, commit changes using version control, and preview changes during review.
Versioning
Give your users documentation that won't go out of date. Build multiple versions from commits, branches, or tags in your repository.
Localization
Integrate with localization tools to translate your documentation in multiple languages.
Track change history
Use the same version control system that you use for development to retain change history for your documentation.
Bring your own tools
Integrate with tools like Sphinx, MkDocs, and Jupyter Book, and track changes with Git or Mercurial. Use the tools that work best for your project.
- Write reStructuredText with Sphinx
- Or write Markdown with Sphinx and MyST
- Add reference docs from Python code
- Document a RESTful API with OpenAPI tools
- Include a Jupyter Notebook in your docs
Build automatically
Your documentation is rebuilt whenever a change is detected in your repository, so every version of your documentation is always up to date.
Whether your project is Python or Node.js, your project controls what dependencies to install and how to generate your documentation.
Build customization
Customize your documentation build to fit your needs. Install your own dependencies and run custom commands.
Configuration file
Set up your project and track your project's configuration from your repository.
Offline formats
Output PDF and EPUB formats for your documentation, for offline and cross-device viewing.
Connect to all of your repositories
Read the Docs integrates with GitHub, GitLab, and Bitbucket and can clone and build documentation from any hosted repository. You can also manually connect to any repository provider that supports Git.
Private repository support Paid plan feature
Clone from private repositories hosted on GitHub, GitLab, and Bitbucket, or connect another provider by manually connecting using a provided key.
Preview your changes
Rebuild your documentation and preview changes in every pull request. Share changes easily and help catch errors before shipping documentaiton updates.
Supported on GitHub and GitLab repositories.
Learn more
Everything in one place
Everything you need to deliver documentation to your users and customers is already included with your project. You can easily deploy multiple versions of your documentation, with everything from authentication to cross-project search, without configuring any additional services.
For every project type
Authentication Paid plan feature
Control who has access to your documentation with integrated authentation and sharing tokens.
Bring your domain
Use your own custom domain for your hosted documentation, with SSL automatically configured.
Integrated search
Help your users find what the need with integrated search across all your projects and versions.
Start automating your documentation with Read the Docs.
Which site best fits your project?
Free for open-source software.
Sign upPlans starting at $50/month.
Sign upAutomation rules
Automatically increment your documentation versions, and rebuild on new version releases.
Subprojects
Subprojects can share a search index and a custom domain, and can help logically group sets of multiple projects.
Environment variables
Use environment variables to provide secrets to your project's build commands.
Redirects
Avoid broken links by adding redirects for pages that have been moved or deleted.
Analytics
Track search query and documentation page traffic data with no additional services.
Webhooks
Connect Read the Docs to other services by sending webhook events after each build.
Notifications
Receive email notifications when a project build encounters an error.
Audit log Paid plan feature
Track and review authentication attempts for your organization and all of your private documentation projects.
Team management Paid plan feature
Control access to your projects within your organization and group projects by teams.