Skip to content

Commit

Permalink
Update Sphinx config
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhad6 committed Aug 24, 2024
1 parent 6094558 commit b309327
Showing 1 changed file with 6 additions and 18 deletions.
24 changes: 6 additions & 18 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,21 @@
"jupyter_sphinx",
]

# Determine the git version to use
import subprocess

def run_command(*args: str) -> str:
return subprocess.check_output(args).decode().strip()

git_version = run_command("git", "rev-parse", "--abbrev-ref", "HEAD")
if git_version == "HEAD":
git_version = run_command("git", "describe", "--exact-match", "--tags")

# Construct GitHub links
git_base_url = "https://github.com/PainterQubits/datalogs"
git_view_link = (
f"{git_base_url}/blob/{git_version}/docs/{{filename}}?plain=1"
)
git_repo_link = f"https://github.com/PainterQubits/datalogs/tree/{git_version}"
# GitHub URL
github_url = "https://github.com/PainterQubits/datalogs"

# HTML output options
html_theme = "furo"
html_static_path = ["_static"]
html_theme_options = {
"source_view_link": git_view_link,
"source_repository": github_url,
"source_branch": "main",
"source_directory": "docs",
# From https://pradyunsg.me/furo/customisation/footer/#using-embedded-svgs
"footer_icons": [
{
"name": "GitHub",
"url": git_repo_link,
"url": github_url,
"html": """
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
Expand Down

0 comments on commit b309327

Please sign in to comment.