Skip to content

feat(docs): enable link to source code #1529

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
bdraco merged 1 commit into from
Feb 15, 2025
Merged

feat(docs): enable link to source code #1529

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
10 changes: 10 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,14 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
"sphinx.ext.todo", # Allow todo comments.
"sphinx.ext.viewcode", # Link to source code.
"sphinx.ext.autodoc",
"zeroconfautodocfix", # Must be after "sphinx.ext.autodoc"
"sphinx.ext.intersphinx",
"sphinx.ext.coverage", # Enable the overage report.
"sphinx.ext.duration", # Show build duration at the end.
"sphinx_rtd_theme", # Required for theme.
]

templates_path = ["_templates"]
Expand All @@ -53,6 +58,11 @@
"**": ("localtoc.html", "relations.html", "sourcelink.html", "searchbox.html"),
}

# -- Options for RTD theme ---------------------------------------------------
# https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html

# html_theme_options = {}

# -- Options for HTML help output --------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-help-output

Expand Down