From 01745eea42aeca93615a24d3d54580a45e75680d Mon Sep 17 00:00:00 2001 From: James B Date: Fri, 1 Sep 2023 09:00:52 +0100 Subject: [PATCH] .readthedocs.yaml Lock black to version that last passed Set theme explicetly --- .readthedocs.yaml | 22 ++++++++++++++++++++++ docs/conf.py | 3 +++ setup.py | 10 +++++++++- 3 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..c4752a6 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.9" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 2124fc2..58ef67d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,4 +10,7 @@ extensions = [ "sphinx.ext.autodoc", + "sphinx_rtd_theme", ] + +html_theme = "sphinx_rtd_theme" diff --git a/setup.py b/setup.py index bdd29f5..e35bb30 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,15 @@ python_requires=">=3.7", install_requires=[], extras_require={ - "dev": ["pytest", "black", "isort", "flake8", "mypy"], + "dev": [ + "pytest", + "black==22.12.0", + "isort", + "flake8", + "mypy", + "sphinx", + "sphinx_rtd_theme", + ], }, classifiers=[], )