Vulkan-Docs/config
Jon Leech dd9919749a Change log for August 13, 2018 Vulkan 1.1.83 spec update:
* Update release number to 83.

Public Issues:

  * Use [%inline] directive for all SVGs to reduce file size (public pull
    request 734).
  * Convert XML `value` aliases into \<alias> tags (public pull request
    747).
  * Fix metadoc script showing non-selected extensions (public pull request
    748).
  * Reapply public pull request 742 to make
    ename:VK_PIPELINE_STAGE_CONDITIONAL_RENDERING_BIT_EXT part of the
    graphices pipeline (public pull request 749).
  * Fix numerous typos related to accidental duplication of words (public
    pull request 760).
  * Fix `vk.xml` contact typos (public pull request 761).

Internal Issues:

  * Add images to the <<Standard sample locations>> table (internal issue
    1115).
  * Add a definition of "`Inherited from`" precision in the
    <<spirvenv-precision-operation, Precision and Operation of SPIR-V
    Instructions>> section (internal issue 1314).
  * Clarify that both built-in and user-defined variables count against the
    location limits for shader interfaces in the
    <<interfaces-iointerfaces-locations, Location Assignment>> section
    (internal issue 1316).
  * Merge "`required`" capabilities into the <<spirvenv-capabilities-table,
    list of optional: SPIR-V capabilities>> (internal issue 1320).
  * Relax the layout matching rules of descriptors referring to only a
    single aspect of a depth/stencil image, by reference to the new
    <<resources-image-layouts-matching-rule, Image Layout Matching Rules>>
    section (internal issue 1346).
  * Revert extension metadoc generator warning about name mismatches to a
    diagnostic, due to annoying warnings in build output for conscious
    choices we've made (internal issue 1351).

Other Issues:

  * Reserve bits for pending vendor extensions.
  * Make Vulkan consistent with SPIR-V regarding code:DepthReplacing and
    code:FragDepth in the <<interfaces-builtin-variables, Built-In
    Variables>> section.
  * Add missing ChangeLog entries for the previous three spec updates.
2018-08-13 06:23:03 -07: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 Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07: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 Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -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 Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07: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 August 13, 2018 Vulkan 1.1.83 spec update: 2018-08-13 06:23:03 -07:00
mathtest.txt Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
optimize-pdf Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07: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 Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -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.