Trsp migration guide (#2260)

* [doc][trsp] Migration guide documentation * [doc][trsp] adding links to migration guide * [link] working out ignored links
pgRouting · Mar 25, 2022 · c229a6f · c229a6f
1 parent 87df79e
commit c229a6f
Show file tree

Hide file tree

Showing 15 changed files with 1,272 additions and 1,745 deletions.
diff --git a/doc/conf.py.in b/doc/conf.py.in
@@ -322,7 +322,8 @@ linkcheck_ignore = [
     'https://docs.pgrouting.org/latest/en/via-category.html',
     'https://docs.pgrouting.org/latest/en/pgr_trspVia_withPoints.html',
     'https://docs.pgrouting.org/latest/en/withPoints-category.html',
-    'https://docs.pgrouting.org/3.4/en/withPoints-category.html',
+    'https://docs.pgrouting.org/latest/en/trsp-migration.html',
+    'https://docs.pgrouting.org/3.4/en/trsp-migration.html',
 
     # FIXME: tmp disable due to Retry-After header for rate-limiting by Github not respected
     #        (see: https://github.com/sphinx-doc/sphinx/issues/7388)

diff --git a/doc/src/index.rst b/doc/src/index.rst
@@ -119,6 +119,11 @@ Available Functions but not official pgRouting functions
     release_notes
 
 
+.. toctree::
+    :hidden:
+
+    trsp_migration
+
 .. rubric:: Indices and tables
 
 * :ref:`genindex`

diff --git a/doc/trsp/CMakeLists.txt b/doc/trsp/CMakeLists.txt
@@ -6,6 +6,7 @@ SET(LOCAL_FILES
     pgr_trspVia_withPoints.rst
     pgr_trsp_withPoints.rst
     pgr_turnRestrictedPath.rst
+    trsp_migration.rst
     )
 
 foreach (f ${LOCAL_FILES})

diff --git a/doc/trsp/TRSP-family.rst b/doc/trsp/TRSP-family.rst
@@ -33,6 +33,9 @@ When points are also given as input:
 
 .. index proposed to here
 
+.. Warning:: Read the :doc:`trsp_migration` about how to migrate from the
+   deprecated TRSP functionality to the new signatures or replacement functions.
+
 .. rubric:: Experimental
 
 .. include:: experimental.rst