docs: Add link back to GitHub repository from the documentation

matthewfeickert commented 2 months ago

At the moment (this is pre merging of PR #444) there is no link from the docs (e.g. https://ssl-hep.github.io/ServiceX_frontend/) back to the GitHub repository (https://github.com/ssl-hep/ServiceX_frontend). This is actually very useful at times for someone developing who:

Searched for the docs or got to them from PyPI.
Is reading the docs and has a technical question that will benefit from seeing the repository.
Wants to be able to reach the repository in a single click and not have to search for where the repository lives on GitHub.

Examples of this being done in Scikit-HEP libraries:

Awkard (this is the nicest form as the GitHub url is always in the page header)

pyhf (not endorsing the busy badge ugliness :P)

The "Edit on GitHub" icon on each page is not really great (so not advocating that), but the whole theme for the pyhf docs is switched to the pydata-sphinx-theme in the next release to make things nicer/more modern overall (like Awkward).

ketan96-m commented 2 months ago

@matthewfeickert Added a link to github the side bar https://ssl-hep.github.io/ServiceX_frontend/databinder.html

matthewfeickert commented 2 months ago

Thanks @ketan96-m! Can you use the Resolves #446 syntax in the body (currently blank) of PR #444 to have this issue get automatically closed once that PR is merged?

matthewfeickert commented 2 months ago

Resolved by PR #444

ssl-hep / ServiceX_frontend

docs: Add link back to GitHub repository from the documentation #446