The source code that powers readthedocs.org
Available items
No Items, yet!
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
Welcome to Read the Docs
|build-status| |docs| |coverage|
Purpose
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/
Documentation for RTD
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_.
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.
. Create an account on Read the Docs
_. You will get an email verifying your
email address which you should accept within 7 days.
. Log in and click on "Import a Project".
. Click "Connect to GitHub" in order to connect your account's repositories to GitHub.
. When prompted on GitHub, give access to your account.
. Click "Import a Repository" and select any desired repository.
. Change any information if desired and click "Next".
. All done. Commit away and your project will auto-update.
.. |build-status| image:: https://img.shields.io/travis/readthedocs/readthedocs.org.svg?style=flat :alt: build status :scale: 100% :target: https://travis-ci.org/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
License
MIT_ © 2010-2020 Read the Docs, Inc & contributors
.. _MIT: LICENSE