index.rst

How-to guides: project setup and configuration

The following how-to guides help you solve common tasks and challenges in the setup and configuration stages.

⏩️ :doc:`Connecting your Read the Docs account to your Git provider </guides/connecting-git-account>`

Steps to connect an account on |git_providers_or| with your Read the Docs account.

⏩️ :doc:`Configuring a Git repository automatically </guides/setup/git-repo-automatic>`

Once your account is connected to your Git provider, adding and configuring a Git repository automatically is possible for |git_providers_and|.

⏩️ :doc:`Configuring a Git repository manually </guides/setup/git-repo-manual>`

If you are connecting a Git repository from another provider (for instance Gitea or Codeberg), this guide tells you how to add and configure the webhook manually.

⏩ :doc:`Adding a configuration file </guides/setup/configuration-file>`

To build your documentation project, you need to add a .readthedocs.yaml configuration file. This guide gets you started.

⏩️ :doc:`Managing custom domains </guides/custom-domains>`

Hosting your documentation using your own domain name, such as docs.example.com.

⏩️ :doc:`Using custom URL redirects in documentation projects </guides/redirects>`

Configuring your Read the Docs project for redirecting visitors from one location to another.

⏩️ :doc:`Managing subprojects </guides/subprojects>`

Need several projects under the same umbrella? Start using subprojects, which is a way to host multiple projects under a "main project".

⏩️ :doc:`Using a .readthedocs.yaml file in a sub-folder </guides/setup/monorepo>`

This guide shows how to configure a Read the Docs project to use a custom path for the .readthedocs.yaml build configuration. Monorepos that have multiple documentation projects in the same Git repository can benefit from this feature.

⏩️ :doc:`Hiding a version </guides/hiding-a-version>`

Is your version (flyout) menu overwhelmed and hard to navigate? Here's how to make it shorter.

.. seealso::

   :doc:`/tutorial/index`
      All you need to know to get started.

.. toctree::
   :maxdepth: 1
   :hidden:

   Connecting your Read the Docs account to your Git provider </guides/connecting-git-account>
   Configuring a Git repository automatically </guides/setup/git-repo-automatic>
   Configuring a Git repository manually </guides/setup/git-repo-manual>
   Adding a configuration file </guides/setup/configuration-file>
   Managing custom domains </guides/custom-domains>
   Managing subprojects </guides/subprojects>
   Hiding a version </guides/hiding-a-version>
   Using a .readthedocs.yaml file in a sub-folder </guides/setup/monorepo>
   Using custom URL redirects in documentation projects </guides/redirects>