Skip to content

readthedocs/readthedocs.org

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8ed3aa3 · Nov 12, 2024
Jun 26, 2024
Nov 11, 2024
Jun 13, 2022
Nov 4, 2024
Nov 12, 2024
Nov 12, 2024
Mar 12, 2012
Aug 17, 2023
Nov 12, 2024
Nov 5, 2024
Jun 18, 2024
Jun 28, 2023
May 11, 2022
Dec 4, 2018
Jan 13, 2020
Nov 29, 2022
Apr 6, 2018
Apr 6, 2018
Jun 1, 2019
Apr 7, 2022
Jul 3, 2019
Apr 6, 2018
Apr 6, 2018
Apr 6, 2018
May 24, 2022
Oct 29, 2024
Jan 21, 2020
Nov 12, 2024
Mar 9, 2023
Sep 7, 2017
Jun 10, 2024
Nov 9, 2022
Jan 5, 2023
Jun 5, 2024
Mar 7, 2021
Feb 7, 2023
May 24, 2022
Nov 12, 2024
Apr 6, 2018
Aug 8, 2023
Apr 15, 2015
Nov 12, 2024
Dec 7, 2017
Jun 20, 2023
Oct 24, 2024
Jun 26, 2024

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