Standardize multi path functions

[cvvergara]

Fixes #2909 .

Changes proposed in this pull request:

• Standarize pgr_EdgeDisjointPaths
• Standarize pgr_turnRestrictedPaths
• More on reorganizing migration

@pgRouting/admins

Summary by CodeRabbit

• New Features

  • Added documentation for new contraction algorithms: pgr_contractionDeadEnd, pgr_contractionLinear, and pgr_contractionHierarchies.
  • Introduced documentation for pgr_degree and pgr_topologicalSort.

• Bug Fixes

  • Standardized and corrected documentation formatting, indexing, and output column descriptions across multiple functions.

• Documentation

  • Major updates to the user manual, including streamlined changelogs, new and reorganized sections, and improved navigation.
  • Expanded and clarified function documentation, with enhanced examples, diagrams, and parameter explanations.
  • Updated and added badges, installation, and citation instructions in the README.

• Chores

  • Updated workflow configurations for compatibility, dependency management, and expanded testing environments.
  • Adjusted .gitignore and removed obsolete configuration files.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update advances the pgRouting project to version 4.0.0, revising documentation, workflows, and configuration files. It standardizes output columns for multi-path functions, promotes several functions from proposed or experimental to official status, removes deprecated elements, adds new documentation for contraction and metrics, adjusts CI workflows, and updates versioning and build requirements.

Changes

File(s) / Path(s)	Change Summary
.github/workflows/*.yml	Updated workflow triggers, PostgreSQL/Boost versions, added Python package installs, improved test matrix logic.
.gitignore	Added .vscode, taptest.sh, and run.sh to ignored files.
.tx/config	Deleted Transifex localization config file.
CMakeLists.txt, configuration.conf, ci/winnie/build_pgrouting.sh	Updated project version to 4.0.0, Boost handling, directory support flags, and build/test script logic.
NEWS.md	Replaced with release notes for 4.0.0, listing promoted functions, breaking changes, and removals.
README.md	Added DOI badge, package manager install info, updated CMake version, and citation section.
doc/_static/custom.css, doc/_static/page_history.js	Added CSS for warnings, improved versioned doc link logic, and updated file history tracking.
doc/CMakeLists.txt, doc/conf.py.in, doc/ordering/CMakeLists.txt, doc/metrics/CMakeLists.txt, ...	Updated build logic, Sphinx config, added/removed documentation files, improved build robustness.
doc/contraction/*, doc/metrics/pgr_degree.rst, doc/ordering/pgr_topologicalSort.rst	Added/expanded documentation for contraction algorithms, degree function, and topological sort.
doc/categories/.rst, doc//*.rst	Standardized documentation structure, indexing, output columns, and versioning for many functions.
doc/alpha_shape/, doc/breadthFirstSearch/, doc/driving_distance/drivingDistance-category.rst	Removed deprecated or re-categorized documentation files.
doc/ksp/CMakeLists.txt, doc/pickDeliver/CMakeLists.txt, doc/driving_distance/CMakeLists.txt	Updated documentation build file lists to match new organization.

Sequence Diagram(s)

Omitted due to the nature of the changes (documentation, configuration, and workflow updates).

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Standardize output columns for pgr_edgeDisjointPaths and pgr_turnRestrictedPath (#2909)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Addition of new contraction and metrics documentation (doc/contraction/*, doc/metrics/pgr_degree.rst)	These changes add new documentation and features not directly related to output column standardization for the specified functions in the linked issue.
Workflow and CI matrix changes (.github/workflows/*.yml)	Workflow improvements and dependency updates are not within the scope of output column standardization.
Removal of Transifex config and changes to .gitignore	These are unrelated housekeeping changes not tied to the output column objectives.

Possibly related PRs

• pgRouting/pgrouting#2784: Also modifies GitHub Actions workflows to add sphinx-collapse to documentation build steps.
• pgRouting/pgrouting#2893: Updates .github/workflows/ubuntu.yml for PostgreSQL version matrix and repository setup, overlapping with this PR’s workflow changes.
• pgRouting/pgrouting#2721: Documents and formalizes the promotion of functions/signatures to official status, matching this PR’s documentation and release note updates.

Suggested labels

Functionality/proposed

Suggested reviewers

• robe2
• bipashabg
• Saloni-2005

Poem

🐇

Version four hops in—what a sight to see!
Docs now align, as neat as can be.
Output columns march in standardized rows,
New functions bloom where the old bunny goes.
With workflows refreshed and warnings in orange hue,
This rabbit’s delighted—release notes anew!

🥕

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.