Edit Source link for Gitea, Forgejo, or other self-hosted online repository

[mlncn]

What's the problem this feature will solve?

All code with repository hosting that supports online editing does not have to be on GitHub, GitLab / self-hosted GitLab, or Bitbucket. Gitea, Forgejo, and others exist and are increasingly popular.

Describe the solution you'd like

Extend the options documented on https://docs.readthedocs.com/platform/stable/guides/edit-source-links-sphinx.html to include "Other" with a display_repo setting that takes uses the following variables:

• repo_host
• repo_user (or org)
• repo_slug (repository name as seen in the URL)
• repo_version (branch)
• conf_src_path (to take the place of hard-coded /src/ and /blob path segments for our flexible custom repo)

The existing variable would still be used:

• conf_py_path (appears right before pagename, defaults to /)
• suffix
• and of course the key one that changes for each page of the docs, pagename

{% if display_repo %}
    <a href="https://{{ repo_host|default("codeberg.org") }}/
    {{ repo_user }}/{{ repo_slug  }}{{ conf_src_path|default("/src/branch") }}{{ repo_version }}
    {{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-git-alt">
    Edit Source</a>
{% endif %}

Alternative solutions

Override default templates, but it is time to support open projects as at least second-class citizens.

Additional context

Pointers for where to add this / how many default themes are supported that should get the above added to their templates would be greatly appreciated.

[EvanBinu]

Hello @mlncn
I am interested in solving this issue.
Can you assign this to me.
Thank you

[mlncn]

@EvanBinu i do not have the power to assign but i hope if you are able to add the code ReadTheDocs will merge it in!

[EvanBinu]

ok @mlncn
I will try adding the code.
Thank you

[EvanBinu]

@mlncn
I have put a Pull Request.
Can you please review it.
Thank you.

[verisimilidude2]

@ericholscher Take a look at this one during PyConUSA sprint

[ericholscher]

I looked at the PR here, and it seems more like theme documentation than RTD?

#12168 (review)

Honestly we should probably just delete the guide that we have, since it isn't actually adding value compared to the theme docs here.,