PyMEOS 1.1 - Final Release

MobilityDB · Mar 23, 2024 · f486e20 · f486e20
2 parents 46b51a6 + 7a164c5
commit f486e20
Show file tree

Hide file tree

Showing 13 changed files with 360 additions and 346 deletions.
diff --git a/README.md b/README.md
@@ -48,4 +48,8 @@ print(f'Speeds: {speed}')
 
 # Call finish at the end of your code
 pymeos_finalize()
-````
+````
+
+# Documentation
+
+Visit our [ReadTheDocs page](https://pymeos.readthedocs.io/en/latest/) for a more complete and detailed documentation, including an installation manual and several examples.
diff --git a/docs/conf.py b/docs/conf.py
@@ -9,7 +9,7 @@
 project = 'PyMEOS'
 copyright = '2023, Víctor Diví'
 author = 'Víctor Diví'
-release = '1.1.3.rc2'
+release = '1.1.3'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,3 @@
-.. PyMEOS documentation master file, created by
-   sphinx-quickstart on Thu Oct  5 18:26:38 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 =======
 PyMEOS
 =======
@@ -33,19 +28,13 @@ distributions using ``pip``:
 
     $ pip install pymeos
 
-.. warning::
-    Versions up to 1.1.2 of PyMEOS (0.0.8 of PyMEOS CFFI) should not be used. Instead,
-    use version 1.1.3 (1.1.0 for PyMEOS CFFI) which is currently in pre-release mode.
-
-    To use it, you have to use the ``--pre`` flag of ``pip``. To avoid installing
-    pre-release versions of the dependencies, install ``pymeos`` normally and then
-    update it using the following command:
-
-    ``pip install --pre --force-reinstall --no-deps pymeos pymeos_cffi``
-
 See the `installation documentation <./src/installation.html>`__
 for more details and advanced installation instructions.
 
+Examples
+==================
+A couple of examples showcasing the capabilities of PyMEOS can be found int the `examples section <./src/examples.html>`__.
+
 .. toctree::
    :caption: User Guide
    :hidden:

diff --git a/docs/src/installation.rst b/docs/src/installation.rst
@@ -18,16 +18,6 @@ time of the PyMEOS release. Install the binary wheel with pip as follows:
 
     $ pip install pymeos
 
-.. warning::
-    Versions up to 1.1.2 of PyMEOS (0.0.8 of PyMEOS CFFI) should not be used. Instead,
-    use version 1.1.3 (1.1.0 for PyMEOS CFFI) which is currently in pre-release mode.
-
-    To use it, you have to use the ``--pre`` flag of ``pip``. To avoid installing
-    pre-release versions of the dependencies, install ``pymeos`` normally and then
-    update it using the following command:
-
-    ``pip install --pre --force-reinstall --no-deps pymeos pymeos_cffi``
-
 
 Installation using conda (incoming, not available yet)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/pymeos/README.md b/pymeos/README.md
@@ -37,4 +37,8 @@ print(f'Speeds: {speed}')
 
 # Call finish at the end of your code
 pymeos_finalize()
-````
+````
+
+# Documentation
+
+Visit our [ReadTheDocs page](https://pymeos.readthedocs.io/en/latest/) for a more complete and detailed documentation, including an installation manual and several examples.
diff --git a/pymeos/pymeos/__init__.py b/pymeos/pymeos/__init__.py
@@ -29,7 +29,7 @@
     MeosGeoJsonOutputError,
 )
 
-__version__ = "1.1.3rc2"
+__version__ = "1.1.3"
 __all__ = [
     # initialization
     "pymeos_initialize",

diff --git a/pymeos/pyproject.toml b/pymeos/pyproject.toml
@@ -34,7 +34,7 @@ license = { file = 'LICENSE' }
 
 requires-python = '>=3.7'
 dependencies = [
-    'pymeos-cffi ==1.1.0rc2',
+    'pymeos-cffi >=1.1.0, <2',
     'python-dateutil',
     'shapely',
 ]