The source code that powers readthedocs.org
|build-status| |docs| |coverage|
Read the Docs_ hosts documentation for the open source community. It supports Sphinx_ docs written with reStructuredText, and can pull from your Subversion, Bazaar, Git, and Mercurial_ repositories. Then we build documentation and host it for you. Think of it as Continuous Documentation.
.. _Read the docs: https://readthedocs.org/ .. _Sphinx: http://www.sphinx-doc.org/ .. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html .. _Subversion: http://subversion.tigris.org/ .. _Bazaar: http://bazaar.canonical.com/ .. _Git: http://git-scm.com/ .. _Mercurial: https://www.mercurial-scm.org/
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/
You can find information about getting in touch with Read the Docs at our
You can find information about contributing to Read the Docs at our
By the end of this quickstart, you will have a new project automatically updated when you push to GitHub.
Read the Docs_. You will get an email verifying your
email address which you should accept within 7 days.
.. |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/master/graph/badge.svg :alt: Test coverage :scale: 100% :target: https://codecov.io/gh/readthedocs/readthedocs.org
MIT_ © 2010-2021 Read the Docs, Inc. & contributors
.. _MIT: LICENSE