Skip to content

Link to GitHub repo from the docs #1415

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

Merged
merged 3 commits into from
Apr 11, 2024
Merged

Link to GitHub repo from the docs #1415

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac89074
Link to GitHub repo from the docs
krassowski Apr 11, 2024
f8cd7e9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 11, 2024
681bb3d
Add html_context to enable links
krassowski Apr 11, 2024
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
20 changes: 19 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,25 @@
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {"navigation_with_keys": False}
html_theme_options = {
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/jupyter-server/jupyter_server",
"icon": "fab fa-github-square",
}
],
"navigation_with_keys": False,
"use_edit_page_button": True,
}

# Output for github to be used in links
html_context = {
"github_user": "jupyter-server", # Username
"github_repo": "jupyter_server", # Repo name
"github_version": "main", # Version
"doc_path": "docs/source/", # Path in the checkout to the docs root
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
Expand Down