docs: Add the start of Vulkan runtime docs

Reviewed-by: Ivan Briano <ivan.briano@intel.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/14961>
2022-02-17 22:10:04 -06:00 · 2022-02-17 22:10:04 -06:00 · 7521b5db18
parent 3501a3f9ed
commit 7521b5db18
3 changed files with 12 additions and 0 deletions
--- a/docs/doxygen-wrapper.py
+++ b/docs/doxygen-wrapper.py
@ -31,6 +31,7 @@ import tempfile
 INPUT_PATHS = [
    'src/compiler/nir/nir.h',
    'src/intel/isl',
+    'src/vulkan/runtime',
 ]

 TEMPLATE_DOXYFILE = Template("""
--- a/docs/index.rst
+++ b/docs/index.rst
@ -112,6 +112,7 @@ Linux, FreeBSD, and other operating systems.
   release-calendar
   dispatch
   gallium/index
+   vulkan/index
   nir/index
   isl/index
   android
--- a/docs/vulkan/index.rst
+++ b/docs/vulkan/index.rst
@ -0,0 +1,10 @@
+Vulkan Runtime
+==============
+
+The Vulkan runtime and utility code in Mesa provides a powerful shared core
+for building Vulkan drivers.  It's a collection of base structures (think
+base classes in OOO) which allow us to implement a bunch of the annoying
+hardware-agnostic bits in common code.
+
+.. toctree::
+   :maxdepth: 2