This document describes how to create HTML specifications for this repo.
Khronos recommends using Asciidoc to author SPIR-V extensions. Asciidoc is a text-based document format that is easy to store and manage in a version control system, like this GitHub repo. For information about the Asciidoc format, please refer to the online documentation.
For most SPIR-V specifications it is easiest to copy and modify an existing SPIR-V extension specification, to ensure there are no missing sections and to have a consistent look-and-feel.
The Asciidoc toolchain supports many output formats. To publish an extension in this repo, generate an HTML specification.
Most specifications in this repo are built with the older Asciidoc toolchain. Please refer to the online documentation to install the Asciidoc toolchain.
A recommended command line to build an HTML specification from Asciidoc source is:
$ asciidoc -b html5 -a icons -a toc2 -a toclevels=1 -o SPV_my_extension.html SPV_my_extension.asciidocThe included Makefile in this repo can also be used to generate an HTML specification from Asciidoc source.