Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trsp migration guide #2260

Merged
merged 3 commits into from
Mar 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 5 additions & 0 deletions doc/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,11 @@ Available Functions but not official pgRouting functions
release_notes


.. toctree::
:hidden:

trsp_migration

.. rubric:: Indices and tables

* :ref:`genindex`
Expand Down
1 change: 1 addition & 0 deletions doc/trsp/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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})
Expand Down
3 changes: 3 additions & 0 deletions doc/trsp/TRSP-family.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading