Skip to content

Add Edit on GitHub button #1862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Gold856 wants to merge 2 commits into from
Closed

Add Edit on GitHub button #1862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aeb51d9
Add Edit on GitHub button
Gold856 Apr 8, 2025
fc4365e
test
Gold856 Apr 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/source/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@
{%- block extrafooter %}
{# Add custom things to the head HTML tag #}

{% if display_github %}
<p>hmmmmmmmmmmmmmm</p>

{% endif %}

<div class="dark-mode-toggle-container">
<strong class="light-label md-icon">&#xE430</strong>

Expand Down
8 changes: 7 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,13 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

html_context = {
"display_github": True, # Integrate GitHub
Copy link
Copy Markdown
Contributor

@mcm001 mcm001 Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I expect to see this link now in https://photonvision-docs--1862.org.readthedocs.build/en/1862/docs/quick-start/arducam-cameras.html ? I don't yet.

"github_user": "photonvision", # Username
"github_repo": "PhotonVision", # Repo name
"github_version": "main", # Version
"conf_py_path": "/docs/source/", # Path in the checkout to the docs root
}
source_suffix = [".rst", ".md"]


Expand Down
Loading