Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
source code to readthedocs.org
Pull request Compare This branch is 1727 commits behind rtfd:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.tx
deploy
docs
logs
media
readthedocs
.gitignore
.gitmodules
.travis.yml
AUTHORS.rst
LICENSE.mit
README.rst
Vagrantfile
deploy_requirements.txt
fabfile-development.py
fabfile.py
manage.py
onebox_requirements.txt
pip_requirements.txt
runtests.sh
setup.py

README.rst

Welcome to Read The Docs

status status

Purpose

Read the Docs hosts documentation for the open source community. It supports Sphinx docs written with reStructuredText, and can pull from your Subversion, Bazaar, Git, and Mercurial repositories.

Documentation for RTD

You will find complete documentation for setting up your project at the Read the Docs site.

Quick start for Github hosted projects

By the end of this quick start you will have a new project automatically updated when you push to Github.

  1. Create an account on Read the docs. You will get an email verifying your email address which you should accept within 7 days.
  2. Login and click on Import
  3. Give your project a name, add the HTTPS link for your Github project, and select Git as your repository type.
  4. Fill in the rest of the form as needed and click create.
  5. On Github click on Settings.
  6. In the sidebar click on "Web Hooks & Services" then find and click on the ReadTheDocs service.
  7. Check the Active setting and click "Update Settings"
  8. All done. Commit away and your project will auto update.
Something went wrong with that request. Please try again.