Skip to content

readthedocs/readthedocs.org

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to Read the Docs

build status Documentation Status Test coverage

Purpose

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.

Documentation for Read the Docs

You will find complete documentation for setting up your project at the Read the Docs site.

Get in touch

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

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 by signing up with GitHub.
  2. When prompted on GitHub, give access to your account.
  3. Log in and click on "Add project".
  4. Start typing the name of your repository and select it from the list, and click "Continue".
  5. Change any information if desired and click "Next".
  6. All done. Commit away and your project will auto-update.

License

MIT © 2010 Read the Docs, Inc. & contributors