Skip to content

Commit

Permalink
docs: Switch to furo theme
Browse files Browse the repository at this point in the history
  • Loading branch information
jackrosenthal committed Sep 29, 2024
1 parent f959cc3 commit 459bd6a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
16 changes: 6 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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,
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ python = "3.12"

[tool.hatch.envs.docs]
dependencies = [
"furo",
"sphinx",
]

Expand Down

0 comments on commit 459bd6a

Please sign in to comment.