Hosting: support repository links when using html_additional_pages

[jdknight]

Details

• Read the Docs project URL: https://readthedocs.org/projects/sphinxcontrib-confluencebuilder/

Expected Result

For all generated pages, the RTD injected versions may have an associated source view/edit links to the respective source repository (e.g. view/edit links to GitHub):

These links should always be pointing to the respective source files for the rendered document.

Actual Result

If pages are published using the html_additional_pages option, these links may not be generated correctly. For example, with a configuration such as:

html_additional_pages = {
    'index': 'index.html',
}

And a project using, for example, GitHub should have the index page resolve to a path such as:

<project>/blob/main/doc/index.html

However, the existing link generates a link to:

<project>/blob/main/doc/index.rst

---

Not that experienced with RTD's implementation, but this may be as simple as:

• Adjusting the configuration scrape logic to capture the html_additional_pages value.
• Adjusting BaseFooterHTML._get_context so that when page_slug maps to an entry in html_additional_pages, page_slug is swapped to the value in the dictionary and source_suffix is cleared.

[humitos]

I'm going to close this issue since we won't integrate the flyout with specific Sphinx things. We are trying to make all our new features to be agnostic of the doctool used.

However, the new flyout we are creating in https://github.com/readthedocs/addons will eventually be customizable and people will be able to re-design it as they want.