Merge pull request #70 from nextmv-io/feature/eng-5669-add-docs-on-nextmv_sklearn-nextmv_gurobi

Update READMEs, links, and versions

Author: sebastian-quintero

README.md

@@ -12,8 +12,9 @@ can find the source for the following packages:
   providing convenience functions for working with scikit-learn models in the
   Nextmv platform.
 
-Please refer to the individual package READMEs for more information.
+To learn more about the SDKs, visit the [docs][docs].
 
-**IMPORTANT!**
-> Please review the LICENSE on each package, as they may not all have the same
-> license.
+**IMPORTANT**: Please review the LICENSE on each package, as they may not all
+have the same license.
+
+[docs]: https://nextmv.io/docs/python-sdks/overview

nextmv-gurobipy/README.md

@@ -3,11 +3,11 @@
 Welcome to `nextmv-gurobipy`, an SDK for integrating Gurobi with the Nextmv
 platform.
 
-**IMPORTANT!**
-> Please note that `nextmv-gurobipy` is provided as _source-available_ software
-> (not _open-source_).
+**IMPORTANT**: Please note that `nextmv-gurobipy` is provided as
+_source-available_ software (not _open-source_). For further information,
+please refer to the [LICENSE](./LICENSE.md) file.
 
-For further information, please refer to the [LICENSE](./LICENSE.md) file.
+To learn more about `nextmv-gurobipy`, visit the [docs][docs].
 
 ## Installation
 
@@ -16,3 +16,5 @@ Requires Python `>=3.9`. Install using `pip`:
 ```bash
 pip install nextmv-gurobipy
 ```
+
+[docs]: https://nextmv.io/docs/python-sdks/nextmv-gurobipy/installation

nextmv-gurobipy/pyproject.toml

@@ -18,7 +18,7 @@ classifiers = [
 ]
 dependencies = [
     "gurobipy>=12.0.1",
-    "nextmv>=0.17.1"
+    "nextmv>=0.18.0"
 ]
 description = "An SDK for integrating Gurobi with the Nextmv platform"
 dynamic = [
@@ -44,7 +44,7 @@ requires-python = ">=3.9"
 
 [project.urls]
 Homepage = "https://www.nextmv.io"
-Documentation = "https://www.nextmv.io/docs"
+Documentation = "https://www.nextmv.io/docs/python-sdks/nextmv-gurobipy/installation"
 Repository = "https://github.com/nextmv-io/nextmv-py"
 
 [tool.hatch.version]

nextmv-gurobipy/requirements.txt

@@ -2,4 +2,4 @@ build>=1.0.3
 ruff>=0.1.7
 twine>=4.0.2
 gurobipy>=12.0.1
-nextmv>=0.17.1
+nextmv>=0.18.0

nextmv-scikit-learn/README.md

@@ -3,13 +3,11 @@
 Welcome to `nextmv-scikit-learn`, an SDK for integrating scikit-learn with the
 Nextmv platform.
 
-## License
+**IMPORTANT**: Please note that `nextmv-scikit-learn` is provided as
+_source-available_ software (not _open-source_). For further information,
+please refer to the [LICENSE](./LICENSE.md) file.
 
-**IMPORTANT!**
-> Please note that `nextmv-scikit-learn` is provided as _source-available_
-> software (not _open-source_).
-
-For further information, please refer to the [LICENSE](./LICENSE.md) file.
+To learn more about `nextmv-scikit-learn`, visit the [docs][docs].
 
 ## Installation
 
@@ -18,3 +16,5 @@ Requires Python `>=3.9`. Install using `pip`:
 ```bash
 pip install nextmv-scikit-learn
 ```
+
+[docs]: https://nextmv.io/docs/python-sdks/nextmv-scikit-learn/installation

nextmv-scikit-learn/pyproject.toml

@@ -18,7 +18,7 @@ classifiers = [
 ]
 dependencies = [
     "scikit-learn>=1.6.1",
-    "nextmv>=0.17.1"
+    "nextmv>=0.18.0"
 ]
 description = "An SDK for integrating scikit-learn with the Nextmv platform"
 dynamic = [
@@ -44,7 +44,7 @@ requires-python = ">=3.9"
 
 [project.urls]
 Homepage = "https://www.nextmv.io"
-Documentation = "https://www.nextmv.io/docs"
+Documentation = "https://www.nextmv.io/docs/python-sdks/nextmv-scikit-learn/installation"
 Repository = "https://github.com/nextmv-io/nextmv-py"
 
 [tool.hatch.version]

nextmv-scikit-learn/requirements.txt

@@ -2,5 +2,5 @@ build>=1.0.3
 ruff>=0.1.7
 twine>=4.0.2
 scikit-learn>=1.6.1
-nextmv>=0.17.1
+nextmv>=0.18.0
 pydantic>=2.5.2