diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7d26f29..7f24f5c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,3 +11,7 @@ build: sphinx: configuration: docs/source/conf.py fail_on_warning: true + +python: + install: + - requirements: docs/requirements.txt diff --git a/CHANGELOG.md b/CHANGELOG.md index fe2f112..d268669 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,9 @@ * use trusted publisher for release (see https://docs.pypi.org/trusted-publishers/) * use `pyproject.toml` for project setup +### Documentation +* use a theme for documentation supporting dark mode + ### Documentation * added use case for ordering test modules (see [#51](https://github.com/pytest-dev/pytest-order/issues/51)) diff --git a/docs/requirements.txt b/docs/requirements.txt index 8e314dc..374aae9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ sphinx>=2.3.1 +furo diff --git a/docs/source/conf.py b/docs/source/conf.py index 20960b9..6413b4b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -104,7 +104,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = "nature" +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 @@ -165,7 +165,7 @@ # html_split_index = False # If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. html_show_sphinx = False