Skip to content

Fix Python docs build errors and warnings - #285

Merged
zfergus merged 1 commit into
mainfrom
docs/fix-errors-and-warnings
Nov 3, 2026
Merged

zfergus merged 1 commit into
mainfrom
docs/fix-errors-and-warnings

Conversation

@zfergus

@zfergus zfergus commented Nov 3, 2026

Copy link
Copy Markdown
Member

Description

Fixes the Sphinx errors and warnings in the Python docs build, touching the pybind11 bindings and docs/source.

  • Define CollisionMesh and ESPParameters before any signature that uses them, so pybind11 emits ipctk.CollisionMesh instead of the C++ name ipc::CollisionMesh, which the docs can't parse.
  • Split define_esp_parameters out of define_esp_potential to allow that ordering.
  • Give enum and object default arguments readable reprs via py::arg_v (e.g., TightInclusionCCD(), PSDProjectionMethod.NONE).
  • Skip pybind11's internal base classes in autoclasstoc, which otherwise warns once per class.
  • Escape |vertices| in docstrings and fix an RST underline length.

API changes

  • None. Only the rendered default-argument reprs in Python signatures change.

Type of change

  • This change requires a documentation update

How Has This Been Tested?

  • Python docs build shows no new warnings

Checklist

  • My code follows the clang-format style guidelines of this project

- Define CollisionMesh and ESPParameters before the signatures that use them
- Give default arguments readable reprs so the docs can parse them
- Skip pybind11 base classes in autoclasstoc
- Escape pipes in docstrings and fix an RST underline length
@zfergus
zfergus merged commit 80fb1d7 into main Nov 3, 2026
12 checks passed
@zfergus
zfergus deleted the docs/fix-errors-and-warnings branch November 3, 2026 02:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant