Merge pull request #218 from JesseLivezey/version-hints

Version hints
BouchardLab · Oct 18, 2023 · 25e4765 · 25e4765
2 parents dc03389 + d964e5d
commit 25e4765
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 2 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -41,7 +41,7 @@ jobs:
           python -m pytest -sv --cov=./ tests
       - name: Build docs
         run: |
-          sphinx-build -W -b html docs/source docs/build
+          sphinx-build -b html docs/source docs/build
       - name: Codecov
         run: |
           python -m codecov
diff --git a/README.md b/README.md
@@ -68,6 +68,15 @@ to build from source and
 
 to run the tests and check formatting.
 
+PyUoI has been built and tested on Python 3.9.18 with
+
+* numpy==1.26.1
+* h5py==3.10.0
+* scikit-learn==1.3.1
+* cython==3.0.4
+* pytest==7.4.2
+* flake8==6.1.0
+
 # Features
 
 PyUoI is split up into two modules, with the following UoI algorithms:

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -213,7 +213,8 @@
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"python": ("https://docs.python.org/", None),
+                       "sklearn": ("https://scikit-learn.org/stable/", None)}
 
 # -- Options for todo extension ----------------------------------------------
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -51,6 +51,15 @@ to build from source and
 
 to run the tests and check formatting.
 
+PyUoI has been built and tested on Python 3.9.18 with
+
+  * numpy==1.26.1
+  * h5py==3.10.0
+  * scikit-learn==1.3.1
+  * cython==3.0.4
+  * pytest==7.4.2
+  * flake8==6.1.0
+
 Docs
 ^^^^