Skip to content

fix(docs): preserve Lua API in Org exports - #40

Merged
HaoZeke merged 1 commit into
mainfrom
fix/lua-org-source
Nov 19, 2026
Merged

HaoZeke merged 1 commit into
mainfrom
fix/lua-org-source

Conversation

@HaoZeke

@HaoZeke HaoZeke commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

Restores seven Lua API functions to the Org docs source so they survive the Org-to-RST export.

The functions are cages_by_signature, guest_occupancy, fingerprint, topology_library, classify_topology, ion_environment and shell_ring_census. Their signatures, defaults, index conventions and result fields were checked against the wrappers in lua/dseams.lua and the registrations in src/lua_api.cpp. Function-signature headings now export as complete RST inline literals, with no raw tildes.

The exporter pins ox-rst 20250428.534, and the workflow runs the same docs/export.el entry point used locally. A drift check fails if the exported RST differs from what is committed. Reverting the Org page to its previous state makes the check fail as expected, and restoring it makes it pass again.

Org code samples: the cages_by_signature call and result-count example are ported into the Org source, and the multi-depth topology-library example is ordered as {lib2, lib3} to match the shallow-to-deep runtime example. The earlier corrected self-contained cage, seeded-affiliation and legacy-ring examples stay in Org and export unchanged.

Tested with sphinx-build -W -b html docs/source docs/build (no warnings).

@HaoZeke
HaoZeke merged commit 79b6daa into main Nov 19, 2026
11 checks passed
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