Vulkan-Docs/config
Jon Leech b59ec03ee3 Change log for February 3, 2019 Vulkan 1.1.99 spec update:
* Update release number to 99.

Public Issues:

  * Add missing pname:pMemoryHostPointerProperties description to
    flink:vkGetMemoryHostPointerPropertiesEXT.txt (public pull request 896).
  * Minor markup fixes (public pull request 900).
  * Minor update to `khronos.css` and markup fixes (originally proposed in
    public pull request 901, but done via an internal MR).

Internal Issues:

  * Document restrictions on image queries for Y'CbCr formats in the
    <<features-formats-requiring-sampler-ycbcr-conversion>> table as well as
    for slink:sname:VkImageFormatProperties and slink:VkImageCreateInfo
    (internal issue 1361).
  * Correct type of the code:FragSizeEXT built-in in the
    <<interfaces-builtin-variables, Built-In Variables>> section (internal
    issue 1526).
  * Clean up math in the <<textures, Image Operations>> chapter by
    refactoring, using better naming conventions, updating diagrams to use
    the correct orientation, etc. (internal merge request 2968).
  * Fix minor typos for slink:VkImageCreateInfo and
    slink:VkImageStencilUsageCreateInfoEXT.
  * Add missing documentation for tlink:VkResolveModeFlagsKHR.
  * Fix extension dependency of pname:scalarBlockLayout in the
    <<features-features-requirements, Feature Requirements>> section.
  * Fix indexing math for shader binding table calculations in the
    <<shader-binding-table-indexing-rules, Indexing Rules>> section, and use
    spelling "`any-hit`" consistently.
  * Reconcile valid usage statement and text for sampled image layouts in
    slink:VkWriteDescriptorSet
    (https://github.com/KhronosGroup/Vulkan-ValidationLayers/issues/551).
  * Make SPIR-V code:OpConvertUToPtr and code:OpConvertPtrToU operations
    require a 64-bit integer for physical storage buffer pointers in the
    <<spirvenv-module-validation, Validation Rules within a Module>>
    section.
  * Update to KaTeX 10.0.

New Extensions:

  * `VK_EXT_filter_cubic`
  * `VK_NV_dedicated_allocation_image_aliasing`
2019-02-04 01:26:23 -08:00
..
extension-highlighter Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
katex_replace Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -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 January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
vulkan-macros Fix some markup (#900) 2019-01-28 03:31:26 -08: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 Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
katex_replace.rb Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
khronos.css Change log for February 3, 2019 Vulkan 1.1.99 spec update: 2019-02-04 01:26:23 -08:00
makeSubmit.py Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
mathtest.txt Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
optimize-pdf Fix links in PDF build (#879) 2018-12-16 20:13:47 -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 Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
vulkan-macros.rb Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08: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.