Skip to content

Commit edc0c5b

Browse files
committed
docs: set up source code linking in docs
1 parent 3a1b12d commit edc0c5b

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docs/conf.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
html_theme_options = {
7272
"sidebar_hide_name": False,
7373
"navigation_with_keys": True,
74-
"source_repository": "https://github.com/crispthinking/athena-protobufs/",
74+
"source_repository": "https://github.com/crispthinking/athena-nodejs-client/",
7575
"source_branch": "main",
7676
"source_directory": "docs/",
7777
"light_css_variables": {
@@ -111,7 +111,7 @@
111111
html_context = {
112112
"display_github": True,
113113
"github_user": "crispthinking",
114-
"github_repo": "athena-protobufs",
114+
"github_repo": "athena-nodejs-client",
115115
"github_version": "main",
116116
"conf_py_path": "/docs/",
117117
}
@@ -166,7 +166,7 @@
166166
todo_include_todos = True
167167

168168
# Output file name
169-
htmlhelp_basename = "AthenaProtobufsdoc"
169+
htmlhelp_basename = "AthenaNodeClientdoc"
170170

171171
# -- TypeScript Sphinx Configuration ----------------------------------------
172172

@@ -186,3 +186,8 @@
186186

187187
# Whether to include inherited members in class documentation
188188
sphinx_ts_include_inherited = True
189+
190+
# Source linking configuration
191+
sphinx_ts_show_source_links = True
192+
sphinx_ts_source_base_url = "https://github.com/crispthinking/athena-nodejs-client/"
193+
sphinx_ts_source_branch = "master"

0 commit comments

Comments
 (0)