docs: add readthedocs site with notebook landing and api page

Author: jgarciab

.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

docs/_static/custom.css

@@ -0,0 +1,20 @@
+:root {
+  --pst-color-primary: #155fa0;
+  --pst-color-secondary: #15806b;
+}
+
+.hero {
+  padding: 1rem 1.25rem;
+  border: 1px solid var(--pst-color-border);
+  border-radius: 0.75rem;
+  background: linear-gradient(120deg, #f2f7fb 0%, #f8fcfb 100%);
+  margin-bottom: 1.25rem;
+}
+
+.hero h1 {
+  margin-bottom: 0.4rem;
+}
+
+.hero p {
+  margin: 0;
+}

docs/api.md

@@ -0,0 +1,15 @@
+# API Reference
+
+```{eval-rst}
+.. autoclass:: remode.ReMoDe
+   :members:
+   :undoc-members:
+```
+
+```{eval-rst}
+.. autofunction:: remode.perform_fisher_test
+```
+
+```{eval-rst}
+.. autofunction:: remode.perform_binomial_test
+```

docs/conf.py

@@ -0,0 +1,49 @@
+"""Sphinx configuration for ReMoDe docs."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version as pkg_version
+from pathlib import Path
+import sys
+
+ROOT = Path(__file__).resolve().parents[1]
+sys.path.insert(0, str(ROOT))
+
+project = "ReMoDe"
+author = "ReMoDe contributors"
+
+try:
+    release = pkg_version("remode")
+except PackageNotFoundError:
+    release = "0+unknown"
+version = release
+
+extensions = [
+    "myst_nb",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx_copybutton",
+    "sphinx_design",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+autodoc_member_order = "bysource"
+autodoc_mock_imports = ["numpy", "pandas", "scipy", "matplotlib"]
+suppress_warnings = ["myst.header"]
+
+myst_enable_extensions = ["colon_fence", "deflist"]
+
+nb_execution_mode = "off"
+nb_execution_show_tb = False
+
+html_theme = "pydata_sphinx_theme"
+html_title = "ReMoDe documentation"
+html_static_path = ["_static"]
+html_css_files = ["custom.css"]
+html_theme_options = {
+    "github_url": "https://github.com/sodascience/remode",
+    "show_toc_level": 2,
+    "navigation_with_keys": True,
+}

docs/index.ipynb

@@ -40,6 +40,14 @@ classifiers = [
 test = [
     "ruff", "pytest", "mypy"
 ]
+docs = [
+    "sphinx>=7,<9",
+    "pydata-sphinx-theme>=0.15",
+    "myst-parser>=2,<5",
+    "myst-nb>=1,<2",
+    "sphinx-copybutton>=0.5",
+    "sphinx-design>=0.6"
+]
 
 [tool.setuptools_scm]
 write_to = "remode/_version.py"