Skip to content

add-project.rst

Latest commit

 

History

History
70 lines (52 loc) · 2.75 KB

add-project.rst

File metadata and controls

70 lines (52 loc) · 2.75 KB

Adding a documentation project

This page takes you through the process of adding a documentation project to Read the Docs. If you have :doc:`connected your Read the Docs account </guides/connecting-git-account>` to GitHub, Bitbucket, or GitLab, and you have admin access to the repository you want to add, 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

  1. Go to your :term:`dashboard`.
  2. Click on :guilabel:`Add project`.
  3. Type the name of the repository you want to add and click on it. If you are using GitHub, make sure you have installed the :ref:`Read the Docs GitHub App <reference/git-integration:GitHub App>` in your repository.
  4. Click on :guilabel:`Continue`.
  5. Edit any of the pre-filled fields with information of the repository.
  6. Click on :guilabel:`Next`.
  7. Add a :term:`configuration file` to your repository if it doesn't exist yet.
  8. Click on :guilabel:`This file exists`.
.. seealso::

   :doc:`/reference/git-integration`
      Your project will be automatically configured with a Git integration.
      Learn more about all the features enabled by that integration on this page.

Manually add your project

  1. Go to your :term:`dashboard`.
  2. Click on :guilabel:`Add project`.
  3. Click on :guilabel:`Configure manually`.
  4. Click on :guilabel:`Continue`.
  5. Fill all the fields of the form.
  6. Click on :guilabel:`Next`.
  7. Add a :term:`configuration file` to your repository if it doesn't exist yet.
  8. Click on :guilabel:`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.

.. seealso::

   :doc:`/guides/setup/git-repo-manual`
      Additional setup steps required for manually created projects. This guide covers setting up SSH keys and webhook integrations.

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 :term:`dashboard`.

.. seealso::

   :doc:`/builds`
      Explanation about the build process.

   :doc:`/config-file/index`
      Practical steps to add a configuration file to your documentation project.

   :doc:`/versions`
      Manage multiple versions of your documentation project.

If you have any trouble, don't hesitate to reach out to us. The :doc:`support </support>` page has more information on getting in touch.