Repository navigation
fix(docs): preserve Lua API in Org exports - #40
Merged
Merged
Conversation
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
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.
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_environmentandshell_ring_census. Their signatures, defaults, index conventions and result fields were checked against the wrappers inlua/dseams.luaand the registrations insrc/lua_api.cpp. Function-signature headings now export as complete RST inline literals, with no raw tildes.The exporter pins
ox-rst20250428.534, and the workflow runs the samedocs/export.elentry 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_signaturecall 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).