dallasgroot/Documentation
1
0
Fork 0
mirror of https://codeberg.org/Codeberg/Documentation.git synced 2026-06-16 05:13:54 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions
Documentation/content/integrations/read-the-docs.md
Javier Pérez c6ac9a9f94 Reduce line length limit and format content (#623) 
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Changed

- Update line length limit from 500 characters to 120 characters.

## Fixed

- Most instances of these lint issues:
  1. Lines longer than 120 characters ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)).
  2. Trailing whitespaces ([MD009](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md)).
  3. Ordered list item prefix ([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md)).
  4. Bare links ([MD034](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md)).

Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/623
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-14 11:38:21 +02:00

4.2 KiB
Raw Blame History

eleventyNavigation
key title parent
Read the Docs Integration Integrating with Read the Docs Integrations

This article will guide you through integrating Codeberg with Read the Docs to allow automatic build of your documentation. It will show you how to connect Read the Docs to a Git repository hosted on Codeberg. To learn how Read the Docs works, take a look at the official Documentation.

{% admonition "warning" %}

Forgejo is currently not official supported by Read the Docs, so this may break in the future.

{% endadmonition %}

Registration

If you do not have an account yet, you must sign up with readthedocs first.

After sign-up you need to login with your user to access your dashboard.

Create new Project

This steps shows how to create a new project on Read the Docs

  1. On the Read the Docs dashboard click "Import a Project"

  2. If you have connected Read the Docs with some provider e.g. GitHub, you see a list of your repos at that provider. Ignore it and click "Import Manually". You should see this screen:

    Image of the Import Manual page

  3. Under "Name" enter the name of your project. Under "Repository URL" enter the Git URL of your repo. It has the form https://codeberg.org/<owner>/<repo>.git. Leave the rest as it is and click "Next"

  4. You should now be on your Project page and see a warning that the project doesn't have a valid Webhook. Ignore that. Go to Admin->Integrations. You should see this screen:

    Image of an admin website of a Read the docs project. The integrations section of the admin page is selected. The content of the Integrations sections states, that 'No integrations are currently configured.'. An error message is shown in red saying that the project does not have a valid webhook set up.

  5. Now click on "Add Integration" and select "GitHub incoming webhook" as type. You should see this screen:

    Image of an admin website of a Read the docs project. The integrations section of the admin page is selected. The page content start with a header saying 'Integration - GitHub incoming webhook'. After some explaining text an url specific to the Read the docs project is shown which can be used to manually configure this webhook. The url shown is marked with a red border.

  6. Copy the URL that is marked Red in the Image. You should keep it secret, as it allows pushing to your Documentation.

  7. Now go to the "Webhooks" Section of the settings of your Codeberg Repo. Create a new "Forgejo" Webhook.

    Image of a Forgejo repository configuration. The tab 'Webhooks' is selected. The button 'Add Webhook' has been clicked and presents a list of possible Webhooks integrations. The 'Forgejo' entry in the list has been marked with a red border.

  8. Under "Target URL" enter the URL you copied from the Read the Docs webhook

  9. Under "Trigger On:" select "All Events"

Image of the Forgejo 'Add Webhook' dialog. The input field for 'Target URL' is marked with a red border. Also the 'All Events' checkout below the 'Trigger On' section is marked with a red border.

Congratulation! Your done! To test it, push a commit in your Codeberg Repo and see if the documentation rebuilds. This may take a few minutes.

Migrate Project

You may migrate a repository that is connected to Read the Docs from another Git forge to Codeberg. In this case, follow these steps:

  1. Go to Admin->Settings of your Project on Read the Docs
  2. Under "Repository URL" enter the Git URL of your Codeberg Repo
  3. Now go to "Integrations". You will see a existing Integration
  4. Click on it to open the Settings of the Integration
  5. Now click on "Delete Webhook"
  6. Jump to Step 5 of the "Create new project" section and follow the steps there