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.

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

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

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

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

⏩️ Managing custom domains </guides/custom-domains>

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

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

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

⏩️ 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".

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

⏩️ Hiding a version </guides/hiding-a-version>

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

⏩️ Changing the versioning scheme of your project </guides/setup/versioning-schemes>

Change how the URLs of your documentation look like, and if your project supports multiple versions or translations.

/tutorial/index

All you need to know to get started.

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> 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> Changing the versioning scheme of your project </guides/setup/versioning-schemes>