Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
source code to readthedocs.org
Python JavaScript HTML CSS Makefile Batchfile
Failed to load latest commit information.
.tx added tx config
deploy Organized requirements.
docs Merge pull request #1461 from rtfd/triaging-docs
logs Put the logs directory in the repo.
media Disallow build pages
readthedocs Revert "Copy README into index, don’t move it."
requirements Add recommonmark to requirements
.gitignore Ignore .tox/ directory
.gitmodules Add new theme
.travis.yml Drop lint from Travis to start
AUTHORS.rst Added self to authors list.
CONTRIBUTING.rst Add contributing doc
LICENSE.mit Fixed #130. Derp.
MANIFEST.in Added top-level requirements file
README.rst Fix main "docs about RTD" link to the current one
bower.json Standardize and document front end development procedures
fabfile-development.py Update fabfile-development.py to not use syncdb
fabfile.py Bump translations
gulpfile.js Change gulpfile execution of django project
package.json Standardize and document front end development procedures
prospector.yml Add test of tox running test and lint commands, update travis
requirements.txt Added top-level requirements file
runtests.sh Forcing tests to be run with LANG=C. Otherwise the tests might fail i…
setup.py clean up imports
tox.ini Add tox setting to disregard local_settings.py

README.rst

Welcome to Read The Docs

build status Documentation 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.

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.