Vulkan-Docs/config
Jon Leech 7376fb77d1 Change log for June 23, 2019 Vulkan 1.1.112 spec update:
* Update release number to 112.

Github Issues:

  * Clarify that it is possible to use the <<memory-host, Host Memory>>
    pname:pfnReallocation callback to free memory in any case that
    pname:pfnFree could be used (public issue 973).

Internal Issues:

  * Clarify range and precision of code:OpImageQueryLod in the discussion of
    scale factor and level-of-detail operation in the
    <<textures-normalized-operations, Normalized Texel Coordinate
    Operations>> section (internal issues 926, 1719).
  * Fix framebuffer layer valid usage statements for
    slink:VkRenderPassCreateInfo, slink:VkRenderPassCreateInfo2KHR, and
    slink:VkFramebufferCreateInfo (internal issue 1670).
  * Refactor common valid usage statements for flink:vkCmdBeginQuery and
    flink:vkCmdBeginQueryIndexedEXT (internal issue 1682).
  * Prohibit the ename:ename:VK_SAMPLER_YCBCR_RANGE_ITU_NARROW range from
    being used in slink:VkSamplerYcbcrConversionCreateInfo for formats with
    a bit depth less than 8 (internal issue 1688).
  * Add missing interactions with `<<VK_EXT_host_query_reset_usage>>` in the
    <<queries, Queries>> chapter (internal issue 1692).
  * Clean up error output from the `optimize-pdf` build script on success.
  * Fix an internal link to the <<spirvenv-correctly-rounded, Correctly
    Rounded>> section in the SPIR-V appendix by adding and referring to that
    anchor.
  * Fix extension version numbers in `vk.xml` for `VK_EXT_filter_cubic` and
    `VK_IMG_filter_cubic`.
  * Specify division precision for negative numbers, and remove statement
    that trigonometric functions have undefined precision, in the
    <<spirvenv-precision-operation, Precision and Operation of SPIR-V
    Instructions>> appendix.
2019-06-23 20:30:19 -07:00
..
chunkindex Change log for April 16, 2019 Vulkan 1.1.107 spec update: 2019-04-16 05:19:43 -07: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
spec-macros Change log for April 16, 2019 Vulkan 1.1.107 spec update: 2019-04-16 05:19: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 April 16, 2019 Vulkan 1.1.107 spec update: 2019-04-16 05:19:43 -07:00
.gitignore Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
README.md Change log for April 16, 2019 Vulkan 1.1.107 spec update: 2019-04-16 05:19: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 March 18, 2019 Vulkan 1.1.104 spec update: 2019-03-17 06:05:46 -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 June 23, 2019 Vulkan 1.1.112 spec update: 2019-06-23 20:30:19 -07:00
spec-macros.rb Change log for April 16, 2019 Vulkan 1.1.107 spec update: 2019-04-16 05:19: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 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 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.