Read the Docs: documentation simplified
=======================================

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: 🚀 Tutorials

   /tutorial/index
   /intro/getting-started-with-sphinx
   /intro/getting-started-with-mkdocs
   /intro/import-guide
   /examples

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: 💡 Explanation

   /choosing-a-site
   /integrations
   /downloadable-documentation
   /environment-variables
   /subprojects
   /localization

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: 🪄 How-to guides

   Project setup and configuration </guides/setup/index>
   Build process </guides/build/index>
   Upgrading and maintaining projects </guides/maintenance/index>
   Content, themes and SEO </guides/content/index>
   Security and access </guides/access/index>
   Account management </guides/management/index>
   Best practice </guides/best-practice/index>
   Troubleshooting problems </guides/troubleshooting/index>

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: 📚 Reference

   /reference/features
   /config-file/index
   /builds
   /build-customization
   /server-side-search/syntax
   /faq
   /api/index
   /changelog
   /about/index
   Developer Documentation <https://dev.readthedocs.io>

.. meta::
   :description lang=en: Automate building, versioning, and hosting of your technical documentation continuously on Read the Docs.

.. Adds a hidden link for the purpose of validating Read the Docs' Mastodon profile
.. raw:: html

   <a style="display: none;" rel="me" href="https://fosstodon.org/@readthedocs">Mastodon</a>

`Read the Docs`_ simplifies software documentation
by building, versioning, and hosting of your docs, automatically.
This enables many "docs like code" workflows,
keeping your code & documentation as close as possible.

Never out of sync |:arrows_counterclockwise:|
    Whenever you push code to your favorite version control system,
    whether that is Git or Mercurial,
    Read the Docs will automatically build your docs
    so your code and documentation are always up-to-date.
    Read more about :doc:`/integrations`.

Multiple versions |:card_index_dividers:|
    Read the Docs can host and build multiple versions of your docs
    so having a 1.0 version of your docs and a 2.0 version
    of your docs is as easy as having a separate branch or tag in your version control system.
    Read more about :doc:`/versions`.

Open Source and User Focused |:heartbeat:|
    Our code is free and `open source <https://github.com/readthedocs/>`_.
    :doc:`Our company </about/index>` is bootstrapped and 100% user focused.
    |org_brand| hosts documentation for over 100,000 large
    and small open source projects,
    in almost every human and computer language.
    |com_brand| supports hundreds of organizations with product and internal documentation.

.. _Read the docs: https://readthedocs.org/

You can find out more about our all the :doc:`features </reference/features>` in these pages.

First steps
-----------

Are you new to software documentation?
Are you looking to use your existing docs with Read the Docs?
Learn about documentation authoring tools such as Sphinx and MkDocs
to help you create fantastic documentation for your project.

* **Tutorial**: :doc:`/tutorial/index`

* **Getting started**:
  :doc:`With Sphinx </intro/getting-started-with-sphinx>` |
  :doc:`With MkDocs </intro/getting-started-with-mkdocs>` |
  :doc:`/choosing-a-site`

* **Importing your existing documentation**:
  :doc:`Import guide </intro/import-guide>`

Read the Docs feature overview
------------------------------

Learn more about configuring your automated documentation builds
and some of the core features of Read the Docs.

* **Overview of core features**:
  :doc:`/custom-domains` |
  :doc:`/versions` |
  :doc:`/downloadable-documentation` |
  :doc:`/server-side-search/index` |
  :doc:`/analytics` |
  :doc:`/pull-requests` |
  :doc:`/build-notifications` |
  :doc:`/user-defined-redirects` |
  :doc:`/security-log`

* **Connecting with GitHub, Bitbucket, or GitLab**:
  :doc:`Connecting your VCS account </connected-accounts>`

* **Read the Docs build process**:
  :doc:`Configuration reference </config-file/index>` |
  :doc:`Build process </builds>` |
  :doc:`Build customization </build-customization>` |
  :doc:`/environment-variables` |
  :doc:`/reference/environment-variables` |
  :doc:`/badges`

* **Troubleshooting**:
  :doc:`/support` |
  :doc:`/faq`


Advanced features of Read the Docs
----------------------------------

Read the Docs offers many advanced features and options.
Learn more about these integrations and how you can get the most
out of your documentation and Read the Docs.

* **Advanced project configuration**:
  :doc:`subprojects` |
  :doc:`Single version docs <single-version>` |
  :doc:`flyout-menu` |
  :doc:`feature-flags`

* **Multi-language documentation**:
  :doc:`Translations and localization <localization>`

* **Versions**
  :doc:`Automation rules <automation-rules>`

* **Topic specific guides**:
  :doc:`How-to guides <guides/index>`

* **Extending Read the Docs**:
  :doc:`REST API <api/index>`



Read the Docs for Business
--------------------------

Read the Docs has a commercial offering with improved support and additional features.

* **Read the Docs for Business**:
  :doc:`Organizations <commercial/organizations>` |
  :doc:`Single sign on <commercial/single-sign-on>` |
  :doc:`Project privacy level <commercial/privacy-level>` |
  :doc:`Sharing externally <commercial/sharing>`


The Read the Docs project and organization
------------------------------------------

Learn about Read the Docs, the project and the company,
and find out how you can get involved and contribute to the development and success
of Read the Docs and the larger software documentation ecosystem.

* **Policies & Process**:
  :doc:`security` |
  :doc:`DMCA takedown policy <dmca/index>` |
  :doc:`/abandoned-projects` |
  :doc:`/unofficial-projects` |
  :doc:`Release notes & changelog <changelog>`


* **The people and philosophy behind Read the Docs**:
  :doc:`About us </about/index>` |
  :doc:`Team <team>` |
  :doc:`Open source philosophy <open-source-philosophy>` |
  :doc:`Our story <story>`

* **Financial and material support**:
  :doc:`advertising/index` |
  :doc:`Sponsors <sponsors>`

* **Legal documents**:
  :doc:`Terms of service <terms-of-service>` |
  :doc:`Privacy policy <privacy-policy>` |
  :doc:`Data processing agreement <legal/dpa/index>`

* **Getting involved with Read the Docs**:
  :doc:`/glossary` |
  :doc:`Developer documentation <rtd-dev:index>`