Welcome to Read The Docs¶
Read the Docs hosts documentation for the open source community. We support Sphinx docs written with reStructuredText and CommonMark. We pull your code from your Subversion, Bazaar, Git, and Mercurial repositories. Then we build documentation and host it for you. Think of it as Continuous Documentation.
The code is open source, and available on github.
The main documentation for the site is organized into a couple sections:
Information about development is also available:
- Getting Started
- Build Process
- Read the Docs features
- Frequently Asked Questions
- My project isn’t building with autodoc
- How do I change my slug (the URL your docs are served at)?
- How do I change behavior for Read the Docs?
- I get import errors on libraries that depend on C modules
Client Error 401when building documentation
- Can I make search engines only see one version of my docs?
- Deleting a stale or broken build environment
- How do I host multiple projects on one CNAME?
- Where do I need to put my docs for RTD to find it?
- I want to use the Blue/Default Sphinx theme
- I want to use the Read the Docs theme locally
- Image scaling doesn’t work in my documentation
- I want comments in my docs
- How do I support multiple languages of documentation?
- Do I need to be whitelisted?
- Does Read The Docs work well with “legible” docstrings?
- Can I document a python package that is not at the root of my repository?
- Alternate Domains
- Localization of Documentation
- VCS Integration
- Canonical URLs
- Single Version Documentation
- Privacy Levels
- User-defined Redirects
- Automatic Redirects
- Content Embedding
- Contributing to Read the Docs
- Development Standards
- Build Environments
- How we use symlinks
- Interesting Settings
- Administrative Tasks
- Overview of issue labels
- Read the Docs Public API