Skip to content

Breakup and improve PMP's documentation#9286

Merged
sloriot merged 41 commits intoCGAL:mainfrom
MaelRL:PMP-schism
Mar 3, 2026
Merged

Breakup and improve PMP's documentation#9286
sloriot merged 41 commits intoCGAL:mainfrom
MaelRL:PMP-schism

Conversation

@MaelRL
Copy link
Copy Markdown
Member

@MaelRL MaelRL commented Jan 17, 2026

Summary of Changes

With the years and the additions to the package "Polygon Mesh Processing" (PMP), the user and reference manuals have grown overly large, making it difficult to find information.

This PR splits the documentation of PMP into four (three new) packages:

  • PMP (core): essential functions, ranging from simple geometric functions to distance functions, feature detection etc.
  • Boolean Operations on Meshes: Corefinement, autorefinement, clipping, splitting, slicing, [upcoming kernel ?]
  • Meshing and Remeshing of Polygon Meshes: combinatorial and geometric, local and global meshing and remeshing.
  • Polygon Mesh Repair: detection and treatment of defects in polygon meshes

TODO:

Tentative TODO:

  • Update some package icons?

Release Management

Integrate after :

  • Affected package(s): PMP
  • Issue(s) solved (if any):
  • Feature/Small Feature (if any): PMP_doc_breakup
  • Link to compiled documentation (obligatory for small feature) wrong link name to be changed
  • License and copyright ownership: no change

@MaelRL MaelRL added this to the 6.2-beta milestone Jan 17, 2026
@MaelRL MaelRL added Enhancement Doc Pkg::PMP depends on another PR This pull-request should only be merged after other ones. labels Jan 17, 2026
@MaelRL

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

For example:

warning: tag INPUT: input source '/home/runner/work/cgal/cgal/PMP_Boolean_operations/include/' does not exist
warning: source '/home/runner/work/cgal/cgal/PMP_Boolean_operations/include' is not a readable file or directory...
@MaelRL

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@sloriot

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@sloriot

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@MaelRL

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@MaelRL

This comment was marked as outdated.

@github-actions
Copy link
Copy Markdown

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/9286/v0/Manual/index.html

@sloriot
Copy link
Copy Markdown
Member

sloriot commented Feb 19, 2026

PMP_repair fully red (but that seems to be the only one)

@MaelRL MaelRL removed the depends on another PR This pull-request should only be merged after other ones. label Feb 19, 2026
@sloriot sloriot mentioned this pull request Mar 3, 2026
62 tasks
@sloriot
Copy link
Copy Markdown
Member

sloriot commented Mar 3, 2026

Successfully tested in CGAL-6.2-Ic-122

Let's merge this version and potentially improve it before the release.

I added a TODO in #8511 to not forget to update the rewrite-rules

@sloriot sloriot added Tested and removed Not yet approved The feature or pull-request has not yet been approved. Ready to be tested Under Testing labels Mar 3, 2026
@sloriot sloriot merged commit 37e6975 into CGAL:main Mar 3, 2026
9 checks passed
@lrineau lrineau deleted the PMP-schism branch April 8, 2026 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants