Add documentation via readthedocs, fix CI. (#3)

BlueBrain · Jul 10, 2024 · 2cd223e · 2cd223e
1 parent 0efa229
commit 2cd223e
Show file tree

Hide file tree

Showing 18 changed files with 31 additions and 8 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -77,7 +77,7 @@ jobs:
     - uses: actions/setup-python@v5
 
     - name: Install cibuildwheel
-      run: python -m pip install cibuildwheel==2.18.1
+      run: python -m pip install cibuildwheel
 
     - name: Build wheels
       run: python -m cibuildwheel --output-dir dist

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  apt_packages:
+    - libopenmpi-dev
+  tools:
+    python: "3.12"
+  jobs:
+    post_checkout:
+      - git submodule update --init
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+   install:
+   - requirements: docs/source/requirements.txt
+   - method: pip
+     path: .
diff --git a/deps/pybind11 b/deps/pybind11
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/source/_static/banner.jpg → docs/source/_static/banner.jpg b/doc/source/_static/banner.jpg → docs/source/_static/banner.jpg
diff --git a/doc/source/api.rst → docs/source/api.rst b/doc/source/api.rst → docs/source/api.rst
diff --git a/doc/source/changes.rst → docs/source/changes.rst b/doc/source/changes.rst → docs/source/changes.rst
diff --git a/doc/source/conf.py → docs/source/conf.py b/doc/source/conf.py → docs/source/conf.py
@@ -1,3 +1,5 @@
+"""Long-standing documentation configuration."""
+
 # -*- coding: utf-8 -*-
 from importlib.metadata import version as get_version
 

diff --git a/doc/source/debugging.rst → docs/source/debugging.rst b/doc/source/debugging.rst → docs/source/debugging.rst
diff --git a/doc/source/disk_scaling.png → docs/source/disk_scaling.png b/doc/source/disk_scaling.png → docs/source/disk_scaling.png
diff --git a/doc/source/filters.rst → docs/source/filters.rst b/doc/source/filters.rst → docs/source/filters.rst
diff --git a/doc/source/index.rst → docs/source/index.rst b/doc/source/index.rst → docs/source/index.rst
diff --git a/doc/source/license.rst → docs/source/license.rst b/doc/source/license.rst → docs/source/license.rst
diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -0,0 +1,3 @@
+mock
+sphinx
+sphinx-bluebrain-theme
diff --git a/doc/source/usage.rst → docs/source/usage.rst b/doc/source/usage.rst → docs/source/usage.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -29,7 +29,7 @@ dependencies = [
     "morphio",
     "mpi4py",
     "libsonata",
-    "numpy",
+    "numpy<2",
     "packaging",
     "pandas",
     "pyarrow<15",

diff --git a/src/functionalizer/schema.py b/src/functionalizer/schema.py
@@ -89,7 +89,7 @@ def schema_for_dataframe(df):
     """Create a Spark schema from the Pandas DataFrame."""
 
     def _type(col):
-        if df.dtypes[col] == object:
+        if df.dtypes[col] is object:
             return T.StringType()
         return typedef.as_spark_type(df.dtypes[col])
 

diff --git a/tox.ini b/tox.ini
@@ -33,10 +33,8 @@ commands =
     ruff format --check
 
 [testenv:docs]
-changedir = doc
-deps =
-    sphinx
-    sphinx-bluebrain-theme
+changedir = docs
+dep_file = docs/source/requirements.txt
 # set warnings as errors using the -W sphinx option
 commands = make html SPHINXOPTS=-W
 allowlist_externals = make