From 3cce0a61ec40479a085c81053bef1225f9925aba Mon Sep 17 00:00:00 2001 From: James B Date: Fri, 27 Sep 2024 15:32:43 +0100 Subject: [PATCH] docs: Switch to ODSC theme & config --- .readthedocs.yaml | 25 +++++++++++++++++++++++++ docs/conf.py | 2 ++ setup.py | 10 +++++++++- 3 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..578dc61 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,25 @@ +# .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-24.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: + - method: pip + path: . + extra_requirements: + - dev diff --git a/docs/conf.py b/docs/conf.py index f4386fe..a74646e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,3 +1,5 @@ project = "JSON Data Ferret" master_doc = "index" + +html_theme = "odsc_default_sphinx_theme" diff --git a/setup.py b/setup.py index 1e9f799..b7852ac 100644 --- a/setup.py +++ b/setup.py @@ -29,7 +29,15 @@ "json-merge-patch", ], extras_require={ - "dev": ["pip-tools", "black==22.3", "flake8", "isort", "django-environ"] + "dev": [ + "pip-tools", + "black==22.3", + "flake8", + "isort", + "django-environ", + "sphinx", + "odsc-default-sphinx-theme", + ] }, python_requires=">=3.9", )