Fix and revise docs (#301)

* Resolve link to benchmarks.py
* Update old links
* Revise install docs

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"

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

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

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,10 +39,8 @@ 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`: 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

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.
 

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