Skip to content

Commit

Permalink
DOC: switch to source code buttong
Browse files Browse the repository at this point in the history
  • Loading branch information
redeboer committed Jan 20, 2024
1 parent c9dbf88 commit 8313462
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
from __future__ import annotations

from sphinx_api_relink.helpers import get_execution_mode
from sphinx_api_relink.linkcode import (
_get_commit_sha, # pyright:ignore[reportPrivateUsage]
)

BRANCH = _get_commit_sha()
REPO_NAME = "bossdoc"

autosectionlabel_prefix_document = True
Expand Down Expand Up @@ -40,12 +44,9 @@
"adr/template.md",
"tests",
]
html_copy_source = True # needed for download notebook button
html_favicon = "_static/favicon.ico"
html_logo = "https://github.com/redeboer/bossdoc/assets/29308176/71ae5632-3aa9-4756-b4bb-8af397c62951"
html_show_copyright = False
html_show_sourcelink = False
html_show_sphinx = False
html_sourcelink_suffix = ""
html_theme = "sphinx_book_theme"
html_theme_options = {
Expand All @@ -58,13 +59,14 @@
},
"path_to_docs": "docs",
"repository_url": f"https://github.com/redeboer/{REPO_NAME}",
"repository_branch": "main",
"repository_branch": BRANCH,
"show_navbar_depth": 2,
"show_toc_level": 2,
"use_download_button": True,
"use_download_button": False,
"use_edit_page_button": True,
"use_issues_button": True,
"use_repository_button": True,
"use_source_button": True,
}
html_title = "BOSS Documentation"
intersphinx_mapping = {
Expand Down Expand Up @@ -102,7 +104,6 @@
"repository_branch": html_theme_options["repository_branch"],
}
todo_include_todos = True
viewcode_follow_imported_members = True
suppress_warnings = [
"myst.domains",
]

0 comments on commit 8313462

Please sign in to comment.