Skip to content
source code to readthedocs.org
Python JavaScript HTML CSS Makefile Batchfile
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE.md May 13, 2016
.tx added tx config Oct 3, 2012
deploy Proper fix Mar 10, 2016
docs Docs: Update alternate domain server name May 17, 2016
logs Put the logs directory in the repo. Mar 12, 2012
media Clean up wording on support page. Jan 13, 2016
readthedocs Move permission checking into base view, not serving code (#2217) May 18, 2016
requirements Update pip and venv May 17, 2016
.gitignore Add env to ignore list May 3, 2016
.gitmodules Add new theme Oct 17, 2013
.travis.yml Post to random channel to reduce noise Sep 15, 2015
AUTHORS.rst Added self to authors list. Jan 5, 2014
LICENSE.mit Fixed #130. Derp. Jan 31, 2012
MANIFEST.in Added top-level requirements file Apr 15, 2015
README.rst Remove extra space May 3, 2016
bower.json Update Stripe's jquery.payment, and change KO field binding type Oct 21, 2015
fabfile.py Drop fab file task for updating theme as well Sep 10, 2015
gulpfile.js Add a per-project advertising opt-out, and form page for preference Mar 9, 2016
manage.py Settings and public domain restructure (#1829) Apr 14, 2016
package.json Replace vendored theme CSS with bower package support Sep 10, 2015
prospector.yml Merge branch 'master' into simple-project-state-tracking Mar 10, 2016
requirements.txt Added top-level requirements file Apr 15, 2015
runtests.sh Forcing tests to be run with LANG=C. Otherwise the tests might fail i… May 21, 2015
setup.py clean up imports Mar 18, 2013
tox.ini Fix linting May 4, 2016

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.

Contributing

You can find information about contributing to Read the Docs at our Contribution page

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.