Skip to content
source code to readthedocs.org
Python JavaScript HTML CSS Makefile Batchfile
Find file
Latest commit 4d6f685 @ericholscher ericholscher Merge pull request #1979 from jezdez/pip8
Bumped pip and virtualenv to current version. Fix #1958.
Failed to load latest commit information.
.tx added tx config
deploy Add rtd import to master
docs Add missing createsuperuser in local VM instructions
logs Put the logs directory in the repo.
media Clean up wording on support page.
readthedocs Remove NGINX_X_ACCEL_REDIRECT. Fixes #1415
requirements Bumped pip and virtualenv to current version. Fix #1958.
.gitignore Split up OAuth services into own path, allow for extension of classes
.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
LICENSE.mit Fixed #130. Derp.
MANIFEST.in Added top-level requirements file
README.rst Link to docs.rtfd.org from badge in README
bower.json Update Stripe's jquery.payment, and change KO field binding type
fabfile.py Drop fab file task for updating theme as well
gulpfile.js Update javascript include paths in gulpfile
manage.py Fix manage.py
package.json Replace vendored theme CSS with bower package support
prospector.yml Lint project code
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 Fix pylint-django version

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.