Repository files navigation

Read the Docs hosts documentation for the open source community. It supportsSphinx docs written withreStructuredText, and can pull from yourSubversion,Bazaar,Git, andMercurial repositories.

You will find complete documentation for setting up your project atthe Readthe Docs site.

By the end of this quickstart, you will have a new project automatically updatedwhen you push to GitHub.

1. Create an account onRead the Docs. You will get an email verifying youremail 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, andselect 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.