Skip to content

doc: rm links to doc source; show links to github code source #1506

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
leondz merged 1 commit into from
Dec 1, 2025
Merged

doc: rm links to doc source; show links to github code source #1506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/requirements-docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
sphinx
sphinx-rtd-theme
sphinx-github-style
8 changes: 8 additions & 0 deletions docs/source/_static/css/garak_theme.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,4 +131,12 @@ h1,
a.icon {
/* font-family: Lato, proxima-nova, Helvetica Neue, Arial, sans-serif;*/
font-family: Arial, Helvetica, Sans-Serif;
}
.linkcode-link {
color: #fff;
font-size: 80%;
margin-left: 10px;
}
.linkcode-link::after {
content: none;
}
18 changes: 15 additions & 3 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
"sphinx.ext.autosummary",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"garak_ext"
"garak_ext",
"sphinx_github_style",
]

intersphinx_mapping = {
Expand All @@ -33,7 +34,10 @@
html_theme = "sphinx_rtd_theme"

# These folders are copied to the documentation's HTML output
html_static_path = ['_static']
html_static_path = ["_static"]

# disable link to doc source
html_show_sourcelink = False

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
Expand All @@ -44,8 +48,16 @@
# -- Options for EPUB output
epub_show_urls = "footnote"

# -- options for github links
linkcode_link_text = "Source"
linkcode_url = "https://github.com/NVIDIA/garak"

# hide module paths
add_module_names = False
autodoc_preserve_defaults = False

import os
import sys

sys.path.insert(0, "../..")
sys.path.append(os.path.abspath("./_ext"))
sys.path.append(os.path.abspath("./_ext"))