Where are the View and Edit links?

[westurner]

Problem

The View and Edit on Github links have disappeared from the RTD TODO layout.html overlay menu?

IMHO this is a regression in essential functionality of ReadTheDocs.
I couldn't find an issue describing why such change or changes were intentionally made? (TODO: git blame on layout.html IIRC)

What is the name of this UI control?

• layout.html overlay menu
• panel
  A name, a github label, and references in the relevant docs would make debugging this easier.

Were we all opted out of the Edit on Github links?

IMHO if users want to opt out of the View and Edit on Github links by editing their conf.py or through the RTD django webapp that's fine.

But we shouldn't all need to add the View and Edit links back when that was the existing functionality that hadn't required opt-in configuration in conf.py.

• Without the 'View' and 'Edit' on Github links, it takes TODO 3-4 more clicks through to the Project, then there's now a down arrow to click to get the Github source url, but we have to find the file in the repo ourselves?

Reproducible Project

• https://django.rtfd.io/
• https://docs.rtfd.io/

Expected Results

There should be 'View' and 'Edit' links on the RTD (overlay) menu control like there were before, or better.

(UX: Can a new user determine how to Edit a given web page on readthedocs?)

Users should be able to opt out of the View and Edit links in the overlay menu and in the sphinx_rtd_theme; TODO(relevant issues).

• https://www.google.com/search?&q=screenshot+of+read+the+docs+menu&tbm=isch
  • 

Actual Result

The user must now:

• find the github url
• find the configured /docs folder
• navigate through the folder paths
  (or use the github file finder with 't' to search for)
  {docname}.{rst,md} from {docname}.html
• and then find the buttons to edit the document through github or github.dev (codespaces)

Relevant Issues

• Flyout: "On GitHub" section with View and Edit buttons #10742

[westurner]

There could be links to make contribution easy by clicking View and/or Edit to edit with:

• gitlab,
• github
• github.dev
• vscode.dev

View and Edit links are an important feature of RTD and should be opt-in by default in order to facilitate collaboration on documentation.

[westurner]

Source:

• https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html

Docs:

• https://docs.readthedocs.io/en/stable/guides/remove-edit-buttons.html
• https://docs.readthedocs.io/en/stable/guides/edit-source-links-sphinx.html

Related issues:

• Allow for disabling of VCS edit buttons sphinx_rtd_theme#536
• Help with removing "Edit on Github" option with ReadTheDocs theme sphinx-doc/sphinx#2386
• Documentation: Also on Enterprise version "Adding “Edit Source” links on your Sphinx theme" #11007
• "Edit on Gitlab" not showing #10057
• Start deprecating old VCS support #8840
• Flyout: "On GitHub" section with View and Edit buttons #10742

[stsewd]

Hi, this was probably removed from the new flyout because it doesn't work for all docs/pages (we don't know the source page of the generated html), maybe @humitos can confirm this.

I do think that simply linking to the repo could be useful.

[humitos]

Hi, this was probably removed from the new flyout because it doesn't work for all docs/pages (we don't know the source page of the generated html), maybe @humitos can confirm this.

Yeah, that was the reason. It only worked with Sphinx and it required injected data at build time.