From 6492572b2543c188922087e708d40c7273b85f53 Mon Sep 17 00:00:00 2001
From: Ben Avrahami <ben.avrahami@biocatch.com>
Date: Thu, 14 Dec 2023 14:38:20 +0200
Subject: [PATCH] furo doc (#9)

* furo doc

* .

* maybe

---------

Co-authored-by: Ben Avrahami <wouldntyouliketoknow@weather.boy>
---
 .readthedocs.yml      | 6 +++++-
 CHANGELOG.md          | 3 +++
 docs/conf.py          | 8 ++++++--
 docs/requirements.txt | 1 -
 pyproject.toml        | 2 +-
 5 files changed, 15 insertions(+), 5 deletions(-)
 delete mode 100644 docs/requirements.txt

diff --git a/.readthedocs.yml b/.readthedocs.yml
index d5154ea..cb714fb 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -4,6 +4,11 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
+  jobs:
+    post_install:
+      - pip install poetry
+      - poetry config virtualenvs.create false
+      - poetry install
 
 sphinx:
   configuration: docs/conf.py
@@ -12,7 +17,6 @@ formats: all
 
 python:
   install:
-    - requirements: docs/requirements.txt
     - method: pip
       path: "."
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0db240c..b02e198 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,4 +1,7 @@
 # envolved Changelog
+## Next
+### Docs
+* changed documentation theme with furo
 ## 1.1.2
 ### Fixed
 * changed type of `args` to be an invariant `Mapping` instead of a `dict`
diff --git a/docs/conf.py b/docs/conf.py
index cbb930e..bffb71d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -141,9 +141,13 @@ def find_source():
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 
-html_theme_options = {"vcs_pageview_mode": "edit"}
+html_theme_options = {
+    "source_repository": "https://github.com/biocatchltd/yellowbox",
+    "source_branch": "master",
+    "source_directory": "docs/",
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
diff --git a/docs/requirements.txt b/docs/requirements.txt
deleted file mode 100644
index 4170c03..0000000
--- a/docs/requirements.txt
+++ /dev/null
@@ -1 +0,0 @@
-sphinx-rtd-theme
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index 89d7521..8a399e9 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -17,7 +17,7 @@ python = "^3.7"
 [tool.poetry.group.dev.dependencies]
 pytest = "*"
 sphinx = {version="^7", python = ">=3.12"}
-sphinx-rtd-theme = {version="*", python = ">=3.12"}
+furo = {version="*", python = ">=3.12"}
 mypy = "*"
 pytest-cov = "^4.1.0"
 ruff = "*"