Read the Docs hosts documentation for the open source community. It supports many documentation tools (e.g. Sphinx docs written with reStructuredText, MkDocs docs written with markdown, among others), and can pull Git repositories. Then we build documentation and host it for you. Think of it as Continuous Documentation, or Docs as Code.
You will find complete documentation for setting up your project at the Read the Docs site.
You can find information about getting in touch with Read the Docs at our Contribution page.
You can find information about contributing to Read the Docs at our Contribution page.
By the end of this quickstart, you will have a new project automatically updated when you push to GitHub.
- Create an account on Read the Docs by signing up with GitHub.
- When prompted on GitHub, give access to your account.
- Log in and click on "Add project".
- Start typing the name of your repository and select it from the list, and click "Continue".
- Change any information if desired and click "Next".
- All done. Commit away and your project will auto-update.
MIT © 2010 Read the Docs, Inc. & contributors