From 3a35744057f9bf6f4d43279ce24d8b272e841c8a Mon Sep 17 00:00:00 2001 From: Mike Taves Date: Fri, 19 Jan 2024 14:48:27 +1300 Subject: [PATCH] Use sphinx-issues for CHANGES.rst, make corrections --- CHANGES.rst | 27 +++++++++++++-------------- docs/requirements.txt | 1 + docs/source/conf.py | 5 +++++ 3 files changed, 19 insertions(+), 14 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 6a5d02e2..c46b0170 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,33 +1,32 @@ 0.9.3: 2019-12-10 ================= -- find_library and libspatialindex library loading https://github.com/Toblerity/rtree/pull/131 +- find_library and libspatialindex library loading :PR:`131` 0.9.2: 2019-12-09 ================= -- Refactored tests to be based on unittest https://github.com/Toblerity/rtree/pull/129 -- Update libspatialindex library loading code to adapt previous behavior https://github.com/Toblerity/rtree/pull/128 -- Empty data streams throw exceptions and do not partially construct indexes https://github.com/Toblerity/rtree/pull/127 +- Refactored tests to be based on unittest :PR:`129` +- Update libspatialindex library loading code to adapt previous behavior :PR:`128` +- Empty data streams throw exceptions and do not partially construct indexes :PR:`127` 0.9.0: 2019-11-24 ================= - Add Index.GetResultSetOffset() -- Add Index.contains() method for object and id (requires libspatialindex 1.9.3+) #116 -- Add Index.Flush() #107 -- Add TPRTree index support (thanks @sdhiscocks #117 ) -- Return container sizes without returning objects #90 -- Add set_result_limit and set_result_offset for Index paging 44ad21aecd3f7b49314b9be12f3334d8bae7e827 +- Add Index.contains() method for object and id (requires libspatialindex 1.9.3+) :PR:`116` +- Add Index.Flush() :PR:`107` +- Add TPRTree index support (thanks :user:`sdhiscocks` :PR:`117`) +- Return container sizes without returning objects :PR:`90` +- Add set_result_limit and set_result_offset for Index paging :commit:`44ad21aecd3f7b49314b9be12f3334d8bae7e827` Bug fixes: -- Better exceptions in cases where stream functions throw #80 +- Better exceptions in cases where stream functions throw :PR:`80` - Migrated CI platform to Azure Pipelines https://dev.azure.com/hobuinc/rtree/_build?definitionId=5 - Minor test enhancements and fixups. Both libspatialindex 1.8.5 and libspatialindex 1.9.3 are tested with CI - 0.8: 2014-07-17 =============== @@ -64,7 +63,7 @@ Bug fixes: - Many more docstrings, sphinx docs, etc -0.5.0: 2009-08-XX +0.5.0: 2009-08-06 ================= 0.5.0 was a complete refactoring to use libsidx - a C API for libspatialindex. @@ -107,8 +106,8 @@ available as a result of this refactoring. - Reraise index query errors as Python exceptions. - Improved persistence. -0.2: -================== +0.2: 19 May 2007 +================ - Link spatialindex system library. 0.1: 13 April 2007 diff --git a/docs/requirements.txt b/docs/requirements.txt index ecb5cc54..49e47461 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ sphinx>=4 +sphinx-issues diff --git a/docs/source/conf.py b/docs/source/conf.py index 20591e28..4a41c041 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -26,6 +26,7 @@ "sphinx.ext.todo", "sphinx.ext.coverage", "sphinx.ext.ifconfig", + "sphinx_issues", ] templates_path = ["_templates"] @@ -59,3 +60,7 @@ # sphinx.ext.autodoc autodoc_typehints = "description" autodoc_typehints_description_target = "documented" + +# sphinx-issues +issues_github_path = "Toblerity/rtree" +issues_commit_prefix = ""