KhronosGroup / SPIRV-Registry

SPIR-V specs
109 stars 72 forks source link

Automatically generate HTML specs and publish them via Github Pages #270

Open kpet opened 1 month ago

kpet commented 1 month ago

The HTML files for the various extensions currently in the repository were generated with various versions of asciidoc or asciidoctor and we do not currently check that the HTML files in the repository match the corresponding asciidoc source.

Following the introduction of an official toolchain in https://github.com/KhronosGroup/SPIRV-Registry/pull/247, we should add automation to guarantee that:

I think the following sequence of steps should get us there:

No longer doing:

kpet commented 1 month ago

2024/08/14 teleconference: consensus in the group to skip automatic checking of the HTML files as a step and transition directly to automatically publishing HTML specs via Github Pages and remove HTML files from the repo.

bashbaug commented 4 weeks ago

In case it helps other vendors updating their extension specs: One of the differences I noticed updating the Intel specs was that text in 'single quotes' is rendered as italics using asciidoc, but not always using asciidoctor. I couldn't figure out how to make the single quote method work reliably, and it's not documented in the asciidoctor docs, so I ended up switching everything to use _underscores_ for italics instead.