From 459bd6adba809ff94acd654467efcf10c35b3168 Mon Sep 17 00:00:00 2001 From: Jack Rosenthal Date: Sun, 29 Sep 2024 01:02:33 -0600 Subject: [PATCH] docs: Switch to furo theme --- docs/conf.py | 16 ++++++---------- pyproject.toml | 1 + 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f13e0d1..6b3dd3d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -101,19 +101,15 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = "alabaster" +html_theme = "furo" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. html_theme_options = { - "description": "Fast XML and text templates for Python", - "logo": "marlin.png", - "logo_name": True, - "github_banner": True, - "github_button": True, - "github_user": "jackrosenthal", - "github_repo": "kajiki", + "source_repository": "https://github.com/jackrosenthal/kajiki", + "source_branch": "master", + "source_directory": "docs/", } # Add any paths that contain custom themes here, relative to this directory. @@ -128,12 +124,12 @@ # The name of an image file (relative to this directory) to place at the top # of the sidebar. -# html_logo = None +html_logo = "_static/marlin.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -html_favicon = "favicon.ico" +html_favicon = "_static/favicon.ico" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/pyproject.toml b/pyproject.toml index 4de8824..59199e9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -73,6 +73,7 @@ python = "3.12" [tool.hatch.envs.docs] dependencies = [ + "furo", "sphinx", ]