index.rst

Read the Docs: documentation simplified

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

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

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

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

.. 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
   /canonical-urls
   /reference/cdn
   /reference/sitemaps
   /reference/404-not-found
   /reference/robots

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

   /downloadable-documentation
   /guides/embedding-content
   /server-side-search/index
   /server-side-search/syntax
   /flyout-menu

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

   /user-defined-redirects
   /reference/analytics
   /security-log
   /badges
   /explanation/documentation-structure
   /guides/best-practice/links
   /security-implications

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

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

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

Mastodon

Read the Docs simplifies software documentation by building, versioning, and hosting of your docs, automatically. Treating documentation like code keeps your team in the same tools, and your documentation up to date.

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. |com_brand| supports hundreds of organizations with product and internal documentation. Learn more about :doc:`our two platforms </choosing-a-site>`.

First time here?

We have a few places for you to get started:

:doc:`/tutorial/index`

Take the first practical steps with Read the Docs.

:doc:`/choosing-a-site`

Learn about the differences between |org_brand| and |com_brand|.

:doc:`/examples`

Start your journey with an example project to hit the ground running.

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`

Learn how to make your builds reproducible.

Build process

Build your documentation with ease:

:doc:`/builds`

Overview of 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`

Host multiple versions of your documentation.

:doc:`/subprojects`

Host multiple projects under a single domain.

:doc:`/localization`

Host your documentation in multiple languages.

:doc:`/versioning-schemes`

Learn about different URL versioning schemes.

:doc:`/custom-domains`

Host your documentation on your own domain.

Maintaining projects

Keep your documentation up to date:

:doc:`/user-defined-redirects`

Redirect your old URLs to new ones.

:doc:`/reference/analytics`

Learn more about how users are interacting with your documentation.

:doc:`/security-log`

Keep track of security events in your project.

Business features

Features for organizations and businesses:

:doc:`/commercial/index`

Learn more about our commercial features.

:doc:`/commercial/organizations`

Learn how to manage your organization on Read the Docs.

:doc:`/commercial/single-sign-on`

Learn how to use single sign-on with Read the Docs.

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:`/analytics`

Learn more about how users are interacting with your documentation.

:doc:`/guides/cross-referencing-with-sphinx`

Learn how to use cross-references in a Sphinx project.

:doc:`All how-to guides </guides/index>`

Browser the entire catalog for many more how-to guides.

Reference

More detailed information about Read the Docs:

:doc:`/api/index`

Automate your documentation with our API and save yourself some work.

:doc:`/changelog`

See what's new in Read the Docs.

:doc:`/about/index`

Learn more about Read the Docs and our company.