Edit link has wrong label

Problem Description

I’m hosting my repo on GitLab, but the edit link says GitHub.

Steps to reproduce the behavior:

1. Configure edit url:

pdoc.render.configure(
    edit_url_map={
        "codefs": "https://gitlab.com/dAnjou/fs-code/-/blob/main/src/codefs/",
    },
)

1. Generate docs

Expected behavior

Edit link says Edit on GitLab.

Actual behavior

Edit link says Edit on GitHub.

[mhils]

I still think it’d make sense to make the label configurable, because there’s already configuration needed for the button to show up.

I think @mrossinek already shared a good way how you can configure the label in https://github.com/mitmproxy/pdoc/issues/333#issuecomment-1013763332, and this approach will continue to work. I’ve set a relatively high bar for adding new CLI configuration switches to pdoc, my goal is to keep things simple where we can (you may be familiar with the German term Eierlegende Wollmilchsau — we try to avoid that here).

a20bee8 adds the “Edit on GitLab”/“Edit Source” wording, which should hopefully fix things for 99% of the use cases. Thank you two again for the feedback and for sharing your approaches! 😃 🍰

[mhils]

The “Edit on GitHub” phrasing originates from sphinx-rtd-theme, see for example on https://docs.readthedocs.io/en/stable/. The motivation for this button is that people can use it to propose changes to the page they are currently viewing with little effort. For example, here’s a PR where someone read the mitmproxy docs, spotted a typo, and immediately proposed a fix: https://github.com/mitmproxy/mitmproxy/pull/5062/. Having “GitHub” in the message signals to the reader that this will be a familiar and low-effort process (assuming they have a GitHub account). Long story short, I think there’s strong precedent for the “Edit [on GitHub]” wording and I would like to keep it that way.

I feel that a “Browse repo” button should much rather point to the repo root and not to individual files. The full source code is also already available as part of the pdoc page. I would be happy to also accomodate GitLab users here, but we want to optimize for the common case (GitHub), where I think the “Edit on GitHub” wording is better. Of course, you can always change it with a custom template. 😃