Skip to content

Commit 3d488c8

Browse files
committed
Use furo theme for documentation
- has dark mode support and fixes some layout problem - split usage into 3 chapters
1 parent 07e3611 commit 3d488c8

File tree

12 files changed

+911
-915
lines changed

12 files changed

+911
-915
lines changed

.readthedocs.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,7 @@ build:
1111
sphinx:
1212
configuration: docs/conf.py
1313
fail_on_warning: true
14+
15+
python:
16+
install:
17+
- requirements: docs/requirements.txt

CHANGES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ The released versions correspond to PyPI releases.
2727
* fixed behavior for `os.access` for symlinks under Windows
2828
* fixes permission problem on querying file properties (see [#1122](../../issues/1122))
2929

30+
### Documentation
31+
* use a theme for documentation supporting dark mode
32+
3033
## [Version 5.7.4](https://pypi.python.org/pypi/pyfakefs/5.7.4) (2025-01-14)
3134
Minor bugfix release.
3235

docs/autopatch.rst

Lines changed: 0 additions & 123 deletions
This file was deleted.

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
project = "pyfakefs"
5757
copyright = """2009 Google Inc. All Rights Reserved.
5858
© Copyright 2014 Altera Corporation. All Rights Reserved.
59-
© Copyright 2014-2024 John McGehee"""
59+
© Copyright 2014-2025 John McGehee and pyfakefs contributors."""
6060
author = "John McGehee"
6161

6262
# The version info for the project you're documenting, acts as replacement for
@@ -128,7 +128,7 @@
128128
# The theme to use for HTML and HTML Help pages. See the documentation for
129129
# a list of builtin themes.
130130
#
131-
html_theme = "pyfakefs_theme"
131+
html_theme = "furo"
132132

133133
# Theme options are theme-specific and customize the look and feel of a theme
134134
# further. For a list of options available for each theme, see the
@@ -204,7 +204,7 @@
204204

205205
# If true, links to the reST sources are added to the pages.
206206
#
207-
# html_show_sourcelink = True
207+
html_show_sourcelink = False
208208

209209
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
210210
#

0 commit comments

Comments
 (0)