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.Then we build documentation and host it for you.Think of it asContinuous Documentation.

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

You can find information about getting in touch with Read the Docs at ourContribution page.

You can find information about contributing to Read the Docs at ourContribution page.

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 a Project".
3. Click "Connect to GitHub" in order to connect your account's repositories to GitHub.
4. When prompted on GitHub, give access to your account.
5. Click "Import a Repository" and select any desired repository.
6. Change any information if desired and click "Next".
7. All done. Commit away and your project will auto-update.

MIT © 2010-2021 Read the Docs, Inc. & contributors