Welcome to Read the Docs

|build-status| |docs| |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.

.. _Read the docs: https://readthedocs.org/ .. _Sphinx: http://www.sphinx-doc.org/ .. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html .. _Git: http://git-scm.com/ .. _MkDocs: https://www.mkdocs.org/ .. _markdown: https://daringfireball.net/projects/markdown/

Documentation for Read the Docs

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

.. _the Read the Docs site: https://docs.readthedocs.io/

Get in touch

You can find information about getting in touch with Read the Docs at our Contribution page <https://docs.readthedocs.io/en/latest/contribute.html#get-in-touch>_.

Contributing

You can find information about contributing to Read the Docs at our Contribution page <https://docs.readthedocs.io/en/latest/contribute.html>_.

Quickstart for GitHub hosted projects

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.

.. |build-status| image:: https://circleci.com/gh/readthedocs/readthedocs.org.svg?style=svg :alt: build status :target: https://circleci.com/gh/readthedocs/readthedocs.org

.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest :alt: Documentation Status :scale: 100% :target: https://docs.readthedocs.io/en/latest/?badge=latest

.. |coverage| image:: https://codecov.io/gh/readthedocs/readthedocs.org/branch/main/graph/badge.svg :alt: Test coverage :scale: 100% :target: https://codecov.io/gh/readthedocs/readthedocs.org

License

MIT_ © 2010 Read the Docs, Inc. & contributors

.. _MIT: LICENSE