Creating a Project on Read the Docs¶
Read the Docs automates the process of building and hosting your documentation. Here’s how to get started with creating a new project:
Start a New Project:
Go to Read the Docs and log in with your account.
Click on the
Import a Project
button or navigate to theDashboard
and thenImport Project
.
Fill in Project Details:
Name: Enter the name of your project, such as
GCPDS - Docs
.Repository URL: Provide the URL of your GitHub repository where the documentation resides, like
https://github.com/UN-GCPD
.Default Branch: Specify the branch that Read the Docs should use to build your documentation, typically
main
ormaster
.Language: Select the language in which your project documentation is written, for example,
English
.
Finalize and Build:
Click the
Next
button to proceed.Read the Docs will import your documentation from the specified repository and branch.
After importing, Read the Docs will automatically build your documentation.
Review and Access Documentation:
Once the build process is complete, you can review your documentation by clicking on the link provided by Read the Docs.
The link to your documentation is usually in the format
https://<projectname>.readthedocs.io/
.
Remember to commit any changes you make to your documentation to your repository, which will trigger a new build on Read the Docs and update your hosted documentation accordingly.