Welcome to Read The Docs

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.