Skip to content

Breakup and improve PMP's documentation #9286

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.

Sign up for GitHub

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

Jump to bottom
Open
MaelRL wants to merge 21 commits into
base: main
Choose a base branch
from
Open

Breakup and improve PMP's documentation #9286

MaelRL wants to merge 21 commits into from
+2,198 −1,603

Conversation

@MaelRL
Copy link
Member

@MaelRL MaelRL commented Jan 17, 2026 •
edited
Loading

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:

  • Update usages of now deprecated PMP border.h (moved to BGL)
  • Test deprecated border.h
  • Fix "Topics" order
  • Move .h but keep include/CGAL/PMP

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 MaelRL mentioned this pull request Jan 17, 2026
Open
@MaelRL

This comment was marked as outdated.

Sign in to view
@github-actions

This comment was marked as outdated.

Sign in to view
MaelRL added 3 commits January 17, 2026 23:21
@MaelRL
Add missing doc dependencies
30d3cf1
@MaelRL
Add .gitkeeps in doc only PMP packages
ac0ce4e 
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
Add missing doc dependency
33b56bd
@MaelRL

This comment was marked as outdated.

Sign in to view
@github-actions

This comment was marked as outdated.

Sign in to view
@sloriot

This comment was marked as outdated.

Sign in to view
@github-actions

This comment was marked as outdated.

Sign in to view
@sloriot

This comment was marked as outdated.

Sign in to view
@github-actions

This comment was marked as outdated.

Sign in to view
@MaelRL

This comment was marked as outdated.

Sign in to view
@github-actions

This comment was marked as outdated.

Sign in to view
@MaelRL
Copy link
Member Author

MaelRL commented Jan 24, 2026

/force-build:v0

@github-actions
Copy link

github-actions bot commented Jan 24, 2026

There was an error while building the doc:

/home/runner/work/cgal/cgal/BGL/include/CGAL/IO/polygon_mesh_io.h:122: warning: unable to resolve link to 'PMP_IO_grp' for \link command
citelist:4: warning: expected <dt> tag but found <dl> instead!
citelist:5: warning: unexpected end of comment while looking for a html description title
/home/runner/work/cgal/cgal/PMP_Boolean_operations/doc/PMP_Boolean_operations/PMP_Boolean_operations.txt:283: warning: \cite command to 'lazard:hal-04907149' does not have an associated number
/home/runner/work/cgal/cgal/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt:106: warning: unable to resolve link to 'PMP_IO_grp' for \link command
/home/runner/work/cgal/cgal/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt:146: warning: unable to resolve link to 'PMP_IO_grp' for \link command
/home/runner/work/cgal/cgal/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt:213: warning: unable to resolve link to 'PMP_IO_grp' for \link command
/home/runner/work/cgal/cgal/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt:280: warning: unable to resolve link to 'PMP_IO_grp' for \link command
/home/runner/work/cgal/cgal/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt:389: warning: unable to resolve link to 'PMP_IO_grp' for \link command
/home/runner/work/cgal/cgal/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt:433: warning: unable to resolve link to 'PMP_IO_grp' for \link command
/home/runner/work/cgal/cgal/Stream_support/doc/Stream_support/IOstream.txt:494: warning: unable to resolve link to 'PMP_IO_grp' for \link command
/home/runner/work/cgal/cgal/Surface_mesh/doc/Surface_mesh/Surface_mesh.txt:336: warning: unable to resolve reference to 'PMP_IO_grp' for \ref command

https://github.com/CGAL/cgal/actions/runs/21316199394

janetournois
janetournois reviewed Jan 26, 2026
View reviewed changes
Documentation/doc/Documentation/Tutorials/Tutorial_reconstruction.txt
ways. If this output mesh is hampered by defects such as holes or
self-intersections, \cgal provide several algorithms to postprocess
it (hole filling, remeshing, etc.) in the package \ref PkgPolygonMeshProcessing "Polygon Mesh Processing".
it (hole filling, remeshing, etc.) in the package \ref PkgPMPMeshRepair "Polygon Mesh Processing".
Copy link
Member

@janetournois janetournois Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a ref to the PMP meshing/remeshing package (or remove remeshing from the parenthesis)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@janetournois janetournois janetournois left review comments

Assignees

No one assigned

Labels

depends on another PR This pull-request should only be merged after other ones. Doc Enhancement Pkg::PMP

Projects

None yet

Milestone

6.2-beta

Development

Successfully merging this pull request may close these issues.

3 participants

@MaelRL @sloriot @janetournois