(Hopefully) fix doc build (#14)

Author: flying-sheep

.readthedocs.yml

@@ -1,12 +1,18 @@
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    pre_create_environment:
+      - asdf plugin add poetry
+      - asdf install poetry latest
+      - asdf global poetry latest
+      - poetry config virtualenvs.create false
+    post_install:
+      - poetry install
+
 sphinx:
   configuration: docs/conf.py
-
-python:
-  version: 3.8
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
+  fail_on_warning: true

docs/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+SPHINXBUILD   ?= poetry run sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/conf.py

@@ -44,6 +44,8 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+autosummary_generate = True
+
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -55,7 +57,7 @@
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 autodoc_mock_imports = ["annoy", "faiss", "pynndescent", "nmslib"]

poetry.lock

@@ -31,12 +31,12 @@ pytest-cov = ">=2.10.1"
 [tool.poetry.group.docs]
 optional = true
 [tool.poetry.group.docs.dependencies]
-sphinx = "^3.4.1"
-sphinx-gallery = "^0.8.2"
-sphinx-rtd-theme = "^0.5.1"
-sphinx-issues = "^1.2.0"
-numpydoc = "^1.1.0"
-matplotlib = "^3.3.3"
+sphinx = ">=4.2.0"
+sphinx-gallery = ">=0.8.2"
+sphinx-rtd-theme = ">=0.5.1"
+sphinx-issues = ">=1.2.0"
+numpydoc = ">=1.1.0"
+matplotlib = ">=3.3.3"
 
 [tool.pytest.ini_options]
 addopts = [

pyproject.toml

@@ -124,7 +124,7 @@ class RnnDBSCAN(ClusterMixin, BaseEstimator):
     See Also
     --------
     simple_rnn_dbscan_pipeline:
-    Create a pipeline of a KNeighborsTransformer and RnnDBSCAN
+        Create a pipeline of a KNeighborsTransformer and RnnDBSCAN
 
     References
     ----------