Read The Docs
Getting Started
Write Your Docs
Import Your Docs
Versions
How we envision versions working
Redirects on root URLs
Build Process
How we build documentation
Understanding what’s going on
Builder Responsibility
Packages installed in the build environment
Writing your own builder
Deleting a stale or broken build environment
Read the Docs features
Github and Bitbucket Integration
Auto-updating
Internationalization
Canonical URLs
Versions
Version Control Support Matrix
PDF Generation
Search
Alternate Domains
Support
Getting Help
Backwards Incompatible Changes
Commercial Support
Frequently Asked Questions
My project isn’t building with autodoc
How do I change behavior for Read the Docs?
I get import errors on libraries that depend on C modules
Client
Error
401
when 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?
Webhooks
Github
Bitbucket
Others
Badges
Status Badges
Project Pages
Style
Alternate Domains
Subdomain Support
CNAME Support
CNAME SSL
rtfd.org
Localization of Documentation
Single project in another language
Project with multiple translations
VCS Integration
GitHub
Bitbucket
Canonical URLs
Example
Enabling
Implementation
Links
Single Version Documentation
Enabling
Effects
Privacy Levels
Understanding the Privacy Levels
Project Objects
Version Objects
Read the Docs Business Features
Organizations
Sharing
Analytics
Installation
What’s available
Contributing to Read the Docs
Tickets
Translations
Running tests
Continuous Integration
Architecture
Diagram
How we use symlinks
Nginx
Subdomains
CNAMEs
Interesting Settings
SLUMBER_USERNAME
SLUMBER_PASSWORD
USE_SUBDOMAIN
PRODUCTION_DOMAIN
MULTIPLE_APP_SERVERS
DEFAULT_PRIVACY_LEVEL
INDEX_ONLY_LATEST
DOCUMENT_PYQUERY_PATH
USE_PIP_INSTALL
Internationalization
Making Strings Localizable
Strings in Templates
Strings in Python
Administrative Tasks
Updating Localization Files
Compiling to MO
Transifex Integration
Read the Docs Public API
A basic API client using slumber
Example of adding a user to a project
API Endpoints
Root
Builds
Build
Files
File
Projects
Project
Users
User
Versions
Version
Filtering Examples
API
bookmarks
builds
doc_builder
core
projects
vcs_support
Designing Read the Docs
Style Catalog
Typekit Fonts
Readthedocs.org Changes
Sphinx Template Changes
Contributing
Read the Docs Theme
Contributing to the theme
How the Table of Contents builds
Other style notes
How do I use this locally,
and
on Read the Docs?
Read the Docs Open Source Philosophy
Official Support
Unsupported
Rationale
Sponsors of Read the Docs
Current sponsors
Past sponsors
Sponsorship Information
Talks about Read the Docs
Random
Configuration of the production servers
Deploying Code
Deploying Nginx
Elastic Search Setup
Servers
Site Checkout
Read The Docs
Docs
»
API
Edit on GitHub
API
ΒΆ
This is the Read The Docs API documentation, autogenerated from the source code.
bookmarks
bookmarks.admin
bookmarks.models
bookmarks.urls
bookmarks.views
builds
builds.admin
builds.models
builds.urls
builds.views
doc_builder
doc_builder.base
doc_builder.envrionments
doc_builder.backends
doc_builder.backends.sphinx
core
core.admin
core.forms
core.middleware
core.models
core.search_sites
core.views
core.management.commands
projects
projects.admin
projects.constants
projects.forms
projects.models
projects.search_indexes
projects.tasks
projects.utils
projects.views
projects.views.public
projects.views.private
vcs_support
vcs_support.base
Read the Docs
v: latest
Versions
latest
stable
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.