Vulkan-Docs/config
Jon Leech 256a1ef661 Change log for November 18, 2018 Vulkan 1.1.93 spec update:
* Update release number to 93.

Public Issues:

  * Add spec language for ename:VK_INDEX_TYPE_NONE_NV and fix up
    slink:VkAccelerationStructureTypeNV (public issue 848).
  * Add missing suffix in description of slink:VkSubpassDescription2KHR
    parameters (public pull request 851).
  * Fix miscellaneous typos (public pull request 855).
  * Add driver ID for Pastel (public pull request 856).
  * Add missing include directive for slink:VkMemoryWin32HandlePropertiesKHR
    implicit valid usage statements (public pull request 857).

Internal Issues:

  * Restrict the storage classes permitted for SPIR-V atomics to what is
    actually supported, in the <<spirvenv-module-validation, Validation
    Rules within a Module>> section (internal issue 1123).
  * Add a missing Valid Usage statement to slink:VkRenderPassCreateInfo for
    the case pname:stencilLoadOp == ename:VK_LOAD_OP_CLEAR, pname:layout ==
    ename:VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL (internal issue
    1408).
  * Modify optimize-pdf script and Makefile to retain non-optimized original
    PDF on errors (internal issue 1435).
  * Add <<spirvenv-module-validation, SPIR-V validation rules>> stating that
    only the listed code:BuiltIn decorations are permitted, and only when
    relevante features and extensions are enabled (internal issue 1449).
  * Remove some duplicated Valid Usage IDs created via cut & paste error
    (internal issue 1455).
  * Build HTML output for extension reference pages (internal issue 1461).
  ** Improve genRef.py handling of aliases defined inside other refpages.
  ** Emit aliases in pygenerator.py.
  ** Add XML noautovalidity flag for VkRenderPassCreateFlags until there
     are some corresponding FlagBits defined.
  ** Corrected types= attribute on some refpage blocks to 'flags'
  ** Added refpage blocks for some missing types detected by CI tests.
  * Fixed many Valid Usage statement issues in slink:VkRenderPassCreateInfo,
    slink:VkSubpassDescription, slink:VkSubpassDescription2KHR,
    slink:VkSubpassDependency2KHR, flink:vkCmdBeginRenderPass,
    flink:vkCmdBeginRenderPass2KHR, and slink:VkRenderPassBeginInfo
    discovered while adding `VK_KHR_create_renderpass2` to the validation
    layers.

New Extensions:

  * `VK_EXT_scalar_block_layout`
  * `VK_EXT_separate_stencil_usage`
2018-11-18 02:55:14 -08:00
..
extension-highlighter Change log for April 15, 2018 Vulkan 1.1.73 spec update: 2018-04-15 03:32:07 -07:00
katex_replace Update pattern used to remove MathJaX script injected by asciidoctor 2018-11-04 02:05:08 -08:00
themes Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vu-to-json Change log for July 7, 2018 Vulkan 1.1.80 spec update: 2018-07-07 02:21:56 -07:00
vulkan-macros Change log for October 7, 2018 Vulkan 1.1.87 spec update: 2018-10-07 06:10:21 -07:00
.gitignore Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
README.md Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
asciidoctor-mathematical-ext.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
attribs.txt Fixed typos 2018-11-16 19:42:02 +01:00
extension-highlighter.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
katex_replace.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
khronos.css Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
makeSubmit.py Change log for October 7, 2018 Vulkan 1.1.87 spec update: 2018-10-07 06:10:21 -07:00
mathtest.txt Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
optimize-pdf Change log for November 18, 2018 Vulkan 1.1.93 spec update: 2018-11-18 02:55:14 -08:00
tilde_open_block.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vu-to-json.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vulkan-macros.rb Change log for October 7, 2018 Vulkan 1.1.87 spec update: 2018-10-07 06:10:21 -07:00

README.md

Vulkan Asciidoc Configuration Files

Macros

The macros in vulkan-macros.rb and vulkan-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.