Skip to content

Commit

Permalink
docs: Switch to furo theme
Browse files Browse the repository at this point in the history
The sphinx-rtd-theme theme is not compatible with Sphinx 7.x yet.

Signed-off-by: Stephen Finucane <stephen@that.guru>
  • Loading branch information
stephenfin committed Jun 28, 2023
1 parent c81fa0d commit 33b2777
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
26 changes: 12 additions & 14 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
# -*- coding: utf-8 -*-
#
# git-pw documentation build configuration file

import git_pw

try:
import sphinx_rtd_theme # noqa
import furo # noqa

has_rtd_theme = True
has_furo_theme = True
except ImportError:
has_rtd_theme = False
has_furo_theme = False

# -- General configuration ------------------------------------------------

Expand All @@ -20,18 +18,18 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx_click.ext', 'reno.sphinxext']

# Add any paths that contain templates here, relative to this directory.
templates_path = []
extensions = [
'reno.sphinxext',
'sphinx_click.ext',
]

# The master toctree document.
master_doc = 'contents'

# General information about the project.
project = u'git-pw'
copyright = u'2018, Stephen Finucane'
author = u'Stephen Finucane'
project = 'git-pw'
copyright = '2018-present, Stephen Finucane'
author = 'Stephen Finucane'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand All @@ -56,5 +54,5 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
if has_rtd_theme:
html_theme = 'sphinx_rtd_theme'
if has_furo_theme:
html_theme = 'furo'
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
sphinx
sphinx-click
reno
sphinx-rtd-theme
furo

0 comments on commit 33b2777

Please sign in to comment.