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

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Getting started

   Tutorial </tutorial/index>
   /intro/add-project
   /intro/doctools
   /examples

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Project setup and configuration

   /config-file/index
   /config-file/v2
   /addons
   /intro/accounts
   /automation-rules
   /guides/reproducible-builds

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Build process

   /builds
   /build-customization
   /reference/git-integration
   /pull-requests
   /build-notifications
   /environment-variables
   /reference/environment-variables

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Hosting documentation

   /versions
   /subprojects
   /localization
   /versioning-schemes
   /custom-domains
   /doc-notifications
   /canonical-urls
   /reference/cdn
   /reference/sitemaps
   /reference/404-not-found
   /reference/robots

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Reading documentation

   /downloadable-documentation
   /visual-diff
   /link-previews
   /guides/embedding-content
   /server-side-search/index
   /server-side-search/syntax
   /flyout-menu

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Maintaining projects

   /user-defined-redirects
   /traffic-analytics
   /search-analytics
   /security-log
   /badges
   /explanation/documentation-structure
   /guides/best-practice/links
   /security-implications
   /reference/main-content-detection
   /custom-script

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Business features

   /commercial/index
   /commercial/organizations
   /commercial/single-sign-on
   /commercial/sharing
   /commercial/subscriptions
   /commercial/privacy-level

.. 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

   /api/index
   /faq
   /changelog
   /about/index
   Developer Documentation <https://dev.readthedocs.io>
   Read the Docs website <https://about.readthedocs.com>

.. 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 managing software documentation
by building and hosting your docs automatically,
using the Git workflow you already use for code.
Treating documentation like code lets your team use tools they already know,
and makes keeping your docs updated easier.

Up to date documentation
    Whenever you push code to Git,
    Read the Docs will automatically build your docs
    so your code and documentation are always up-to-date.
    Get started with our :doc:`tutorial </tutorial/index>`.

Documentation for every version
    Read the Docs can host multiple versions of your docs.
    Keep your 1.0 and 2.0 documentation online,
    pulled directly from Git.
    Start hosting all your :doc:`versions </versions>`.

Open source and user focused
    Our company is bootstrapped and 100% user-focused,
    so our product gets better for our users instead of our investors.
    |org_brand| hosts documentation for over 100,000 large
    and small open source projects at no cost.
    |com_brand| supports hundreds of organizations with product and internal documentation.
    Learn more about these differences on `our pricing page <https://about.readthedocs.com/pricing/>`_.

First time here?
----------------

We have a few places for you to get started:

.. descriptions here are active

:doc:`/tutorial/index`
  Follow the Read the Docs tutorial.

:doc:`/intro/doctools`
  Quick start for MkDocs and Docusaurus.

:doc:`/examples`
  Start your journey with an example project to learn how to use Read the Docs.

Project setup and configuration
-------------------------------

Start with the basics of setting up your project:

:doc:`/config-file/index`
  Learn how to configure your project with a ``.readthedocs.yaml`` file.

:doc:`/guides/reproducible-builds`
  Keep your builds working by making them reproducible.

Build process
-------------

Build your documentation with ease:

:doc:`/builds`
  Understand how documentation builds happen.

:doc:`/pull-requests`
  Setup pull request builds and enjoy previews of each commit.

Hosting documentation
---------------------

Learn more about our hosting features:

:doc:`/versions`
  Give your readers multiple versions of your documentation.

:doc:`/subprojects`
  Host multiple projects under a single domain.

:doc:`/localization`
  Translate your documentation into multiple languages.

:doc:`/versioning-schemes`
  Learn about different URL versioning schemes.

:doc:`/custom-domains`
  Brand your documentation on your own domain.

Maintaining projects
--------------------

All the tools you need as your project matures:

:doc:`/user-defined-redirects`
  Redirect your old URLs to new ones.

:doc:`/traffic-analytics`
  Learn more about how users are interacting with your documentation.

:doc:`/security-log`
  Keep track of security events in your project.

Business features
-----------------

Our Business hosting has everything your business needs:

:doc:`/commercial/organizations`
  Manage permissions across multiple teams.

:doc:`/commercial/single-sign-on`
  Stay secure with single sign-on.

:doc:`/commercial/sharing`
  Share your private docs easily with contractors or customers.

How-to guides
-------------

Step-by-step guides for common tasks:

:doc:`/guides/pull-requests`
  Setup pull request builds and enjoy previews of each commit.

:doc:`/guides/cross-referencing-with-sphinx`
  Learn how to use cross-references in a Sphinx project.

:doc:`All how-to guides </guides/index>`
  Browse all our how-to guides.

Reference
---------

More detailed information about Read the Docs:

:doc:`/api/index`
  Integrate Read the Docs into your other workflows.

:doc:`/changelog`
  See what's new in Read the Docs.

:doc:`/about/index`
  Learn more about Read the Docs and our company.