From 9718015d1af5d66d5a4aa99199cf6189baf4e199 Mon Sep 17 00:00:00 2001 From: Jesse Livezey Date: Wed, 18 Oct 2023 17:21:13 -0400 Subject: [PATCH 1/2] better version hinting --- README.md | 9 +++++++++ docs/source/installation.rst | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/README.md b/README.md index 73447a3..6efc2c2 100644 --- 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/installation.rst b/docs/source/installation.rst index d05f75d..2bb0b9e 100644 --- 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 ^^^^ From d964e5d5381d48b5e22010ca16ac057fc56da738 Mon Sep 17 00:00:00 2001 From: Jesse Livezey Date: Wed, 18 Oct 2023 17:21:19 -0400 Subject: [PATCH 2/2] docs updates --- .github/workflows/tests.yml | 2 +- docs/source/conf.py | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 39ecc86..69215ee 100644 --- 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/docs/source/conf.py b/docs/source/conf.py index cb129cf..3fef63f 100644 --- 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 ----------------------------------------------