Documentation#173
Merged
Merged
Conversation
…dings - core: document PathPlanner.maxIterations/timeOut, TrapezoidalTimeParameterization properties, ConfigProjector.lineSearchType/maxIterations/errorThreshold, Node.connectedComponent setter, SteeringMethod.constraints getter - constraints: document DifferentiableFunction call/properties, Implicit.comparisonType getter/setter (const char* to avoid kwargs mismatch), ExplicitConstraintSet.errorSize, HierarchicalIterative and BySubstitution errorThreshold/maxIterations/rightHandSide* - manipulation: document Problem.constraintGraph, TransitionPlanner.innerPlanner/ checkFeasibilityOnly/nRandomConfig/nDiscreteSteps, Handle properties, EndEffectorTrajectorySteeringMethod, Cartesian steering method - All getter/setter pairs with /// on both sides use const char* constants instead of DocClassMethod to avoid Boost.Python more_keywords_than_function_arguments static_assert - Add doc/core_doc_todo.md, doc/constraints_doc_todo.md, doc/manipulation_doc_todo.md with full status tables for all binding files
…ndings All⚠️ and ❌ entries in core, constraints and manipulation that had writable docstrings are now ✅. MD files reflect the current state.
…ttern Veuillez saisir le message de validation pour vos modifications. Les lignes
… collisions (path validation and path projector)
nim65s
reviewed
Jul 21, 2026
Comment on lines
+4
to
+8
| Vs gen_api_md.py v1: | ||
| - Full Python type annotations with clickable type links, embedded directly in | ||
| the code display (HTML <pre> block) — no separate parameter table needed | ||
| - Per-method sub-headings (### / ####) for sidebar navigation | ||
| - Docstrings shown as blockquotes under each signature |
Member
There was a problem hiding this comment.
I can't see anything about v1. was it ever published ?
Contributor
Author
There was a problem hiding this comment.
They were only internal labels. I had several versions while trying different markdown themes, and I forgot to clean up the file.
nim65s
reviewed
Jul 21, 2026
nim65s
reviewed
Jul 21, 2026
nim65s
reviewed
Jul 21, 2026
Co-authored-by: Guilhem Saurel <guilhem.saurel@laas.fr>
Co-authored-by: Guilhem Saurel <guilhem.saurel@laas.fr>
…ython -m fix_stubs instead
…ries pybind11-stubgen now writes to stubs_raw/, fix_stubs reads from there and writes fixed stubs to stubs/ via --output-dir. CMake can now track each step independently with BYPRODUCTS and install().
nim65s
approved these changes
Jul 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add documentation to all pyhpp modules and handle class documentation
Add a stub generation script that fixes .pyi files to include all
function signatures and docstrings.
Add a script that generates a Markdown API reference from the pyhpp
stubs, for use in the hpp-python mdBook.