Skip to content


Subversion checkout URL

You can clone with
Download ZIP
source code to
Python JavaScript HTML CSS Makefile Batchfile
Branch: master

Merge pull request #1744 from nikolas/patch-3

Add missing space in Project.single_version description
latest commit ccff2c2e46
@ericholscher ericholscher authored
Failed to load latest commit information.
.tx added tx config
deploy Add basic docstring
docs Add support for public domain.
logs Put the logs directory in the repo.
media Merge pull request #1695 from rtfd/import-improve-ux
readthedocs Merge pull request #1744 from nikolas/patch-3
requirements remove simplejson in favor of built-in json
.gitignore House keeping
.gitmodules Add new theme
.travis.yml Post to random channel to reduce noise
AUTHORS.rst Added self to authors list.
CONTRIBUTING.rst Add contributing doc Fixed #130. Derp. Added top-level requirements file
README.rst Link to from badge in README
bower.json Version bump Update to not use syncdb Drop fab file task for updating theme as well
gulpfile.js Update javascript include paths in gulpfile Fix
package.json Replace vendored theme CSS with bower package support
prospector.yml Lint project code
requirements.txt Added top-level requirements file Forcing tests to be run with LANG=C. Otherwise the tests might fail i… clean up imports
tox.ini Clean up linting errors


Welcome to Read The Docs

build status Documentation Status


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.

Quickstart for GitHub-Hosted Projects

By the end of this quickstart, 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. Log in 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, navigate to your repository and 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.