-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Feature details
Right now, projects with doc pages that inherit from the PennyLane Sphynx theme have to either override the header and footer configs in order to set any GitHub links to their respective repository, or deal with links always pointing to the PennyLane repository.
The former is suboptimal because it would hardcode standard elements like the discussion forum link, and also ignore any temporary additions like a button to the current QHack event.
Ideally, the theme should consider the github_repo attribute in order to set any links accordingly.
Specifically, I'm talking about these navbar elements:

But the issue may apply to other things as well, like as these elements down here:

(But maybe we want to keep those hardcoded to PennyLane? π€)
Implementation
Something along the lines of:
github_repo = app.config["html_theme_options"].get("github_repo", None)
if github_repo is not None:
NAVBAR_RIGHT[-1]["href"] = "https://github.com/" + github_repoHow important would you say this feature is?
1: Not important. Would be nice to have.
Additional information
No response