search

sile-typesetter / sile

The SILE Typesetter — Simon’s Improved Layout Engine
https://sile-typesetter.org
MIT License
1.61k stars 97 forks source link

Auto-generate Lua API documentation #1998

Closed alerque closed 4 months ago

alerque commented 4 months ago

Closes #1337

Still need to think of a place to host this.

alerque commented 4 months ago

For now I assume a single version rebuilt from a branch HEAD will be fine. At the moment the docs are pretty spotty. Whet it gets to the point of being generally useful we would probably want to host versions matching SILE releases. The same will be true of manuals and Rust API docs.

This probably means getting the Nix Flake setup with an option to generate docs, then using that from the website repo build script to generate the docs for desired branches and tags as part of the static site build.

alerque commented 4 months ago

The issue of versioning (and hence stable URS) is not addressed yet, but the Lua API docs are being posted on the SILE website: https://sile-typesetter.org/lua-api/.

Definitely not complete but, enough that even I've learned some about SILE internals from reading them!

I'm probably going to merge this soon because this needs to be added to and tweaked as the main develop branch, not off here on its own.

alerque commented 4 months ago

(Rebuilds currently happen running the website repo CI, not the CI for this repo. I'm looking into how to setup a rebuild hook so the website updates any time the development branch does.)