Skip to content

Feature/lua api autogen #1649

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.

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

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Feature/lua api autogen #1649

wants to merge 18 commits into from

Conversation

cscheid
Copy link
Collaborator

@cscheid cscheid commented May 1, 2025

This PR uses the output of Lua-LS --doc to auto-generate API documentation.

Structure:

  • _*.md files are automatically generated by quarto run tools/build-lua-types-autogen.ts
  • _*.qmd files include the associated _*.md file, and can add additional hand-written material to the top of the document (see docs/lua/quarto/brand.qmd for a minimal example)
  • if the tools/build-lua-types-autogen.ts script is run with stubs as the first parameter, it will overwrite the .qmd files in docs/lua.
  • all files in this directory run with the docs/lua/luaapi_autogen.lua filter which drops some bad markdown generated by Lua-LS.

Copy link
Contributor

github-actions bot commented May 1, 2025

🚀 Deployed on https://deploy-preview-1649.quarto.org

@github-actions github-actions bot temporarily deployed to pull request May 1, 2025 18:52 Inactive
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.

6 participants