5abf83f95d
* Update release number to 107. Public Issues: * Fix revision date for the `<<VK_AMD_gpu_shader_half_float>>` appendix (public issue 617). * Make <<synchronization-pipeline-barriers-subpass-self-dependencies, subpass self-dependencies>> less restrictive (public issue 777). * Fix the `<<VK_EXT_full_screen_exclusive>>` dependency on `<<VK_KHR_win32_surface>>` in `vk.xml` (public pull request 849). * Remove single-page (`apispec.html`) refpage sub-targets from the Makefile `allman` target and the build instructions. The target is still present in the Makefile, but we have not been actively maintaining the single-page document and do not promise it will work. The full Specification and the individual API reference pages are what we support and publish at present (public issue 949). Internal Issues: * De-duplicate common valid usage statements shared by multiple commands or structures by using asciidoctor includes and dynamically assigning part of the valid usage ID based on which command or structure they're being applied to (internal issue 779). * Add reference pages for constructs not part of the formal API, such as platform calling convention macros, and script changes supporting them This required suppressing some check_spec_links warning classes in order to pass CI, until a more sophisticated fix can be done (internal issue 888). * Change math notation for the elink:VkPrimitiveTopology descriptions to use short forms `v` and `p` instead of `vertex` and `primitive`, increasing legibility (internal issue 1611). * Rewrite generated file includes relative to a globally specified path, fixing some issues with refpage generation (internal issue 1630). * Update contributor list for `<<VK_EXT_calibrated_timestamps>>`. * Fix use of pathlin in `scripts/generator.py` so the script will work on Windows under Python 3.5 (internal merge request 3107). * Add missing conditionals around the <<descriptorsets-accelerationstructure, Acceleration Structure>> section (internal merge request 3108). * More script synchronization with OpenXR spec repository (internal merge request 3109). * Mark the `<<VK_AMD_gpu_shader_half_float>>` and `<<VK_AMD_gpu_shader_int16>>` extensions as deprecated in `vk.xml` and the corresponding extension appendices (internal merge request 3112). New Extensions: * `<<VK_EXT_headless_surface>>` |
||
---|---|---|
.. | ||
chunkindex | ||
extension-highlighter | ||
katex_replace | ||
spec-macros | ||
themes | ||
vu-to-json | ||
.gitignore | ||
README.md | ||
asciidoctor-mathematical-ext.rb | ||
attribs.txt | ||
extension-highlighter.rb | ||
katex_replace.rb | ||
khronos.css | ||
makeSubmit.py | ||
mathtest.txt | ||
optimize-pdf | ||
spec-macros.rb | ||
tilde_open_block.rb | ||
vu-to-json.rb |
README.md
Vulkan Asciidoc Configuration Files
Macros
The macros in spec-macros.rb
and spec-macros/extension.rb
are
described in the "Vulkan Documentation and Extensions: Procedures and
Conventions" document (see the styleguide).
Support for Math
Asciidoctor is customized to insert KaTeX <script>
tags from
math.js
for HTML5, and properly pass through math which has
\begin{}\/end{}
delimiters instead of []
.
For PDF builds, asciidoctor-mathematical is used to generate
math-docbook.conf
is heavily conditionalized depending on whether the
final output format (which should be described in the a2x-format variable)
is pdf
or not, since Docbook passes through math differently to dblatex
vs. the XHTML stylesheets. This could be simplified now that we're only
using Docbook for PDFs.
Stylesheets
khronos.css
is the stylesheet used for HTML output.
Chunked Spec Index
chunkindex
contains scripts for building and using a search index for the
Vulkan chunked HTML specification.