Skip to content

docs: set up source code linking in docs #20

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
snus-kin merged 3 commits into from
Sep 11, 2025
Merged

docs: set up source code linking in docs #20

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edc0c5b
docs: set up source code linking in docs
snus-kin Sep 10, 2025
d1c8e32
Merge branch 'main' into feature/source-link-docs
snus-kin Sep 10, 2025
2638066
docs: link to 'main' instead of 'master'
snus-kin Sep 11, 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
11 changes: 8 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
html_theme_options = {
"sidebar_hide_name": False,
"navigation_with_keys": True,
"source_repository": "https://github.com/crispthinking/athena-protobufs/",
"source_repository": "https://github.com/crispthinking/athena-nodejs-client/",
"source_branch": "main",
"source_directory": "docs/",
"light_css_variables": {
Expand Down Expand Up @@ -111,7 +111,7 @@
html_context = {
"display_github": True,
"github_user": "crispthinking",
"github_repo": "athena-protobufs",
"github_repo": "athena-nodejs-client",
"github_version": "main",
"conf_py_path": "/docs/",
}
Expand Down Expand Up @@ -166,7 +166,7 @@
todo_include_todos = True

# Output file name
htmlhelp_basename = "AthenaProtobufsdoc"
htmlhelp_basename = "AthenaNodeClientdoc"

# -- TypeScript Sphinx Configuration ----------------------------------------

Expand All @@ -186,3 +186,8 @@

# Whether to include inherited members in class documentation
sphinx_ts_include_inherited = True

# Source linking configuration
sphinx_ts_show_source_links = True
sphinx_ts_source_base_url = "https://github.com/crispthinking/athena-nodejs-client/"
sphinx_ts_source_branch = "main"