From 71c31b36ad5b6bad8184654820d4cf38239a5928 Mon Sep 17 00:00:00 2001 From: Mike Taves Date: Fri, 19 Jan 2024 22:27:10 +1300 Subject: [PATCH 1/3] Resolve link to benchmarks.py --- docs/source/performance.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/performance.rst b/docs/source/performance.rst index a2b6d647..e4d8d95a 100644 --- a/docs/source/performance.rst +++ b/docs/source/performance.rst @@ -3,10 +3,10 @@ Performance ------------------------------------------------------------------------------ -See the `tests/benchmarks.py`_ file for a comparison of various query methods +See the `benchmarks.py`_ file for a comparison of various query methods and how much acceleration can be obtained from using Rtree. -.. _tests/benchmarks.py: https://raw.github.com/Rtree/Rtree/master/tests/benchmarks.py +.. _benchmarks.py: https://github.com/Toblerity/rtree/blob/master/benchmarks/benchmarks.py There are a few simple things that will improve performance. From 36d9cf7cc3e2eef5a1f135d06feb9faf0dba1038 Mon Sep 17 00:00:00 2001 From: Mike Taves Date: Fri, 19 Jan 2024 22:43:39 +1300 Subject: [PATCH 2/3] Update old links --- docs/source/conf.py | 2 +- docs/source/history.rst | 18 +++++++++--------- docs/source/index.rst | 8 ++++---- docs/source/install.rst | 6 ++---- docs/source/tutorial.rst | 8 +++----- 5 files changed, 19 insertions(+), 23 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 4a41c041..57228c7b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -55,7 +55,7 @@ # -- Extension configuration ------------------------------------------------- -intersphinx_mapping = {"python": ("http://docs.python.org/3", None)} +intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} # sphinx.ext.autodoc autodoc_typehints = "description" diff --git a/docs/source/history.rst b/docs/source/history.rst index 9a286296..e9cb65a2 100644 --- a/docs/source/history.rst +++ b/docs/source/history.rst @@ -34,14 +34,14 @@ is part of that source tree. The code bases are independent from each other and can now evolve separately. Rtree is pure Python as of 0.6.0+. -.. _`Sean Gillies`: http://sgillies.net/blog/ -.. _`Howard Butler`: http://hobu.co -.. _`Brent Pedersen`: http://hackmap.blogspot.com/ -.. _`QGIS`: http://qgis.org +.. _`Sean Gillies`: https://sgillies.net +.. _`Howard Butler`: https://hobu.co +.. _`Brent Pedersen`: https://github.com/brentp +.. _`QGIS`: https://qgis.org -.. _`ZODB`: http://www.zodb.org/ -.. _`R-trees`: http://en.wikipedia.org/wiki/R-tree -.. _`ctypes`: http://docs.python.org/library/ctypes.html -.. _`libspatialindex`: https://libspatialindex.org/ -.. _`Rtree`: http://rtree.github.com +.. _`ZODB`: https://zodb.org +.. _`R-trees`: https://en.wikipedia.org/wiki/R-tree +.. _`ctypes`: https://docs.python.org/3/library/ctypes.html +.. _`libspatialindex`: https://libspatialindex.org +.. _`Rtree`: https://rtree.readthedocs.io diff --git a/docs/source/index.rst b/docs/source/index.rst index 725425c9..ec162c51 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -34,7 +34,7 @@ Documentation * :ref:`modindex` * :ref:`search` -.. _`R-trees`: http://en.wikipedia.org/wiki/R-tree -.. _`ctypes`: http://docs.python.org/library/ctypes.html -.. _`libspatialindex`: https://libspatialindex.org/ -.. _`Rtree`: http://toblerity.github.com/rtree/ +.. _`R-trees`: https://en.wikipedia.org/wiki/R-tree +.. _`ctypes`: https://docs.python.org/3/library/ctypes.html +.. _`libspatialindex`: https://libspatialindex.org +.. _`Rtree`: https://rtree.readthedocs.io diff --git a/docs/source/install.rst b/docs/source/install.rst index 377f6703..eb87c5dd 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -39,7 +39,5 @@ is as easy as:: c:\python2x\scripts\easy_install.exe Rtree -.. _`PyPI`: http://pypi.python.org/pypi/Rtree/ -.. _`Rtree`: http://pypi.python.org/pypi/Rtree/ - -.. _`libspatialindex`: https://libspatialindex.org/ +.. _`PyPI`: https://pypi.org/project/Rtree/ +.. _`libspatialindex`: https://libspatialindex.org diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst index fe7835ab..c237aaf8 100644 --- a/docs/source/tutorial.rst +++ b/docs/source/tutorial.rst @@ -205,8 +205,6 @@ storage backend for `ZODB`_ and you can find example python code `here`_. Note that the code was written in 2011, hasn't been updated and was only an alpha version. -.. _here: https://github.com/Toblerity/zope.index.rtree - -.. _ZODB: http://www.zodb.org/ - -.. _`libspatialindex`: https://libspatialindex.org/ +.. _`here`: https://github.com/Toblerity/zope.index.rtree +.. _`ZODB`: https://zodb.org +.. _`libspatialindex`: https://libspatialindex.org From 5825b52fb970bdecc0a32be0f0093cdf81d33b52 Mon Sep 17 00:00:00 2001 From: Mike Taves Date: Fri, 19 Jan 2024 22:44:03 +1300 Subject: [PATCH 3/3] Revise install docs --- docs/source/install.rst | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/source/install.rst b/docs/source/install.rst index eb87c5dd..063f7343 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -8,26 +8,29 @@ Installation First, download and install version 1.8.5+ of the `libspatialindex`_ library from: -https://libspatialindex.org/ +https://libspatialindex.org -The library is a GNU-style build, so it is a matter of:: +The library supports CMake builds, so it is a matter of:: - $ ./configure; make; make install + $ mkdir build && cd build + $ cmake .. + $ cmake --build . -j + $ cmake --install . You may need to run the ``ldconfig`` command after installing the library to ensure that applications can find it at startup time. -At this point you can get Rtree 0.7.0 via easy_install:: +Rtree can be easily installed via pip:: - $ easy_install Rtree + $ pip install Rtree -or by running the local setup.py:: +or by running in a local source directory:: - $ python setup.py install + $ pip install -e . You can build and test in place like:: - $ python setup.py test + $ pytest Windows .............................................................................. @@ -36,7 +39,7 @@ The Windows DLLs of `libspatialindex`_ are pre-compiled in windows installers that are available from `PyPI`_. Installation on Windows is as easy as:: - c:\python2x\scripts\easy_install.exe Rtree + pip install Rtree .. _`PyPI`: https://pypi.org/project/Rtree/