Adding a documentation project

This page takes you through the process of adding a documentation project to Read the Docs. If you have connected your Read the Docs account to GitHub, Bitbucket or GitLab you will be able to add your project automatically. Otherwise, you will need to add it manually and perform some extra steps.

Automatically add your project

Go to your dashboard.
Click on Add project.
Type the name of the respository you want to add and click on it.
Click on Continue.
Edit any of the pre-filled fields with information of the repository.
Click on Next.
Add a configuration file to your repository if it’s doesn’t exist yet.
Click on This file exists.

Manually add your project

Go to your dashboard.
Click on Add project.
Click on Configure manually.
Click on Continue.
Fill all the fields of the form.
Click on Next.
Add a configuration file to your repository if it’s doesn’t exist yet.
Click on This file exists.

Once your project is created, you’ll need to manually configure the repository webhook if you would like to have new changes trigger builds for your project on Read the Docs.

What’s next

Once your documentation project is created, a build will be triggered. It will automatically fetch the code from your repository and build the documentation. You can see the logs for the build process from your dashboard.