Fix the edit this page link

[akaszynski]

Inspired by ansys/pymapdl#2012, this PR fixes the "Edit this page" button, which is currently overall because of the move from "doc/" to "doc/source".

Moreover, it also provides correct links for our:

• Gallery examples
• Autosummary examples

These were broken even before the documentation move.

---

@germa89 and @jorgepiloto, I suggest that we implement it this way, it's guarenteed to get to the right source file location rather than implementing a search in GitHub.

[codecov]

Codecov Report

Merging #4320 (68f6999) into main (f7510a7) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #4320   +/-   ##
=======================================
  Coverage   95.78%   95.78%           
=======================================
  Files          97       97           
  Lines       20762    20774   +12     
=======================================
+ Hits        19886    19898   +12     
  Misses        876      876           

[jorgepiloto]

Thanks for the ping, @akaszynski. This is something we need to stream up to our repositories.

[germa89]

To avoid having the search option there are two possibilities:

• Using GitHub API to get where the function is defined. Actually it cannot be done i believe. Github can only provides files, lines numbers and commits.
• Using python libraries to retrieve where the object is defined. Problem of this, you need to instantiate the object in order to then use something like func.__module__ and func.__file__. That will probably made the whole documentation building very slow. Further more, the object definition you get when building the object (for instance ansys.mapdl.core.Mapdl.exit might not always match the real object. For instance ansys.mapdl.core.launch_mapdl defined in ansys.mapdl.core.launcher.launch_mapdl.

The whole thing needs careful thinking. It should be possible. But it needs more than what I did in ansys/pymapdl#2012

Temporary alternative, we could maybe link the search to provide directly the first result though. Github search API should provide information enough to directly link the first result of the search.

-- edit --
Realised it is not needed to instantiate each object. But we need to import them though.

[akaszynski]

Temporary alternative, we could maybe link the search to provide directly the first result though. Github search API should provide information enough to directly link the first result of the search.

I think the "edit this page" button should always jump to a github edit page, regardless of if it jumps right to the function or not (which is not available within GitHub's API). Sending them to a search function means that we'll have different behavior depending on if it's an autosummary or not.

Fully agree that it's not a perfect solution, but "edit" seems like it should go to an "edit" page.

[banesullivan]

Generally, LGTM!

Haven't given this a thorough review but all looks right to me and agree with conclusions of previous discussions