switch docs theme

Author: Gerit Wagner

docs/_static/css/custom.css

@@ -0,0 +1,38 @@
+body > div.wy-grid-for-nav > nav > div > div.wy-side-nav-search > a {
+  font-size: 150%;
+}
+
+.wy-nav-content {
+  max-width: 1200px !important;
+}
+
+.fullwidthtable {
+  table-layout: fixed;
+  width: 100%;
+  overflow-wrap: break-word;
+}
+
+pre {
+  white-space: pre-wrap !important;
+}
+
+pre.span.s1 {
+  margin: 0 28px;
+  text-indent: -28px;
+}
+
+.sphinx_collapse {
+  margin-bottom: 24px;
+}
+
+.wy-table-responsive table {
+  width: 100%;
+}
+
+td {
+  white-space: normal !important;
+}
+
+#endpoint_overview_container table tr {
+  height: 200px;
+}

docs/conf.py

@@ -28,6 +28,12 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "furo"
+html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
+# html_logo = "logo_small.png"
+html_favicon = "favicon.ico"
+html_css_files = [
+    "css/custom.css",
+]
 html_title = "BibDedupe"
+# html_logo = "figures/logo.png"

docs/favicon.ico

@@ -1,5 +1,25 @@
-BibDedupe Documentation
-======================================
+.. raw:: html
+
+    <h1 style="display:none;">BibDedupe Documentation</h1>
+
+.. raw:: html
+
+    <div style="text-align: center;">
+        <img src="https://raw.githubusercontent.com/CoLRev-Environment/bib-dedupe/main/docs/figures/logo.png" alt="BibDedupe logo" width="300"><br><br>
+
+        <img src="https://joss.theoj.org/papers/b954027d06d602c106430e275fe72130/status.svg" alt="JOSS status"
+             onclick="window.open('https://joss.theoj.org/papers/b954027d06d602c106430e275fe72130')">
+        <img src="https://img.shields.io/pypi/pyversions/bib-dedupe" alt="Supported Python versions"
+             onclick="window.open('https://pypi.org/project/bib-dedupe/')">
+        <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white" alt="pre-commit enabled"
+             onclick="window.open('https://github.com/pre-commit/pre-commit')">
+        <img src="https://img.shields.io/github/actions/workflow/status/CoLRev-Environment/bib-dedupe/.github%2Fworkflows%2Ftests.yml?label=tests" alt="CI tests"
+             onclick="window.open('https://github.com/CoLRev-Environment/bib-dedupe/actions/workflows/tests.yml')">
+        <img src="https://img.shields.io/github/actions/workflow/status/CoLRev-Environment/bib-dedupe/.github%2Fworkflows%2Fdocs.yml?label=docs" alt="Docs build"
+             onclick="window.open('https://github.com/CoLRev-Environment/bib-dedupe/actions/workflows/docs.yml')">
+        <img src="https://img.shields.io/github/actions/workflow/status/CoLRev-Environment/bib-dedupe/.github%2Fworkflows%2Fevaluate.yml?label=continuous%20evaluation" alt="Continuous evaluation"
+             onclick="window.open('https://github.com/CoLRev-Environment/bib-dedupe/actions/workflows/evaluate.yml')">
+    </div><br>
 
 BibDedupe is an open-source **Python library for deduplication of bibliographic records**, tailored for literature reviews.
 Unlike traditional deduplication methods, **BibDedupe** focuses on entity resolution, linking duplicate records instead of simply deleting them.

docs/figures/logo.png

@@ -44,7 +44,7 @@ dev = [
     "pytest-skip-slow>=0.0.5",
 ]
 docs = [
-    "furo>=2024.8.0",
+    "sphinx-rtd-theme>=3.0.0",
     "sphinx-copybutton>=0.5.2",
 ]