fixing docs build (#211)

* fixing docs build

* Fixing .readthedocs.yml

* add graphviz dep to rtd yml

* Update docs/requirements.txt

* Fixing rtd yaml

* trying with prereqs

* update setup.cfg test reqs

* Test imports

* tweak import test

* More debugging goggle installs

* don't ignore goggle

* testing pyreverse removal

* remove pyreverse

* Clean up

* Pydantic bugfix

* bugfix pydantic v2

.readthedocs.yml

@@ -0,0 +1,30 @@
+# 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.8"
+  apt_packages:
+    - graphviz
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+python:
+  install:
+    - requirements: prereq.txt
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - all

docs/conf.py

@@ -29,12 +29,12 @@
         "-f",
         "-o",
         "generated",
-        "-t", "_templates",
+        "-t",
+        "_templates",
         "../src/synthcity/",
     ]
 )
 
-
 emojis = [
     ":rocket:",
     ":key:",
@@ -52,7 +52,7 @@
     ":rotating_light:",
 ]
 
-#with open("../README.md", "rt") as fin:
+# with open("../README.md", "rt") as fin:
 #    with open("README.md", "wt") as fout:
 #        for line in fin:
 #            for emoji in emojis:
@@ -73,9 +73,9 @@
     "sphinxemoji.sphinxemoji",
     "nbsphinx",
     "sphinx_diagrams",
-    'IPython.sphinxext.ipython_console_highlighting',
-    'sphinx.ext.graphviz','sphinx.ext.inheritance_diagram',
-    "sphinx_pyreverse",
+    "IPython.sphinxext.ipython_console_highlighting",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.inheritance_diagram",
 ]
 
 autodoc_default_options = {

setup.cfg

@@ -78,6 +78,7 @@ testing =
     black
     black-nb
     darglint
+    docutils<0.18
     doc8
     flake8
     isort

src/synthcity/metrics/eval_statistical.py

@@ -310,7 +310,6 @@ def _evaluate_stats(
         X_gt: DataLoader,
         X_syn: DataLoader,
     ) -> Tuple[Dict, Dict, Dict]:
-
         stats_gt = {}
         stats_syn = {}
         stats_ = {}
@@ -711,7 +710,6 @@ def _evaluate(
         X: DataLoader,
         X_syn: DataLoader,
     ) -> Dict:
-
         results = {}
 
         X_ = X.numpy().reshape(len(X), -1)

src/synthcity/plugins/core/schema.py

@@ -41,7 +41,7 @@ class Schema(BaseModel):
     """
 
     sampling_strategy: str = "marginal"  # uniform or marginal
-    protected_cols = ["seq_id"]
+    protected_cols: List[str] = ["seq_id"]
     random_state: int = 0
     data: Any = None
     domain: Dict = {}

tests/plugins/core/test_schema.py

@@ -10,8 +10,12 @@
 
 
 def test_schema_fail() -> None:
-    with pytest.raises(pydantic.error_wrappers.ValidationError):
-        Schema(data="sdfsfs")
+    if pydantic.__version__ < "2":
+        with pytest.raises(pydantic.error_wrappers.ValidationError):
+            Schema(data="sdfsfs")
+    else:
+        with pytest.raises(pydantic.pydantic_core._pydantic_core.ValidationError):
+            Schema(data="sdfsfs")
 
 
 def test_schema_ok() -> None: