Add a spellchecking mode for sphinx and fix some typos

* The worst one was Persistant -> Persistent. This involved renaming
  PersistentConfig but the impact of that is considered minimal enough to be
  worth fixing.

renderdoc/api/replay/common_pipestate.h

@@ -467,7 +467,7 @@ struct BoundVBuffer
 :type: int
 )");
   uint32_t byteStride = 0;
-  DOCUMENT(R"(The size of the buffer binding, or 0xFFFFFFFF if the whole buffer is bound.
+  DOCUMENT(R"(The size of the buffer binding, or ``0xFFFFFFFF`` if the whole buffer is bound.
 
 :type: int
 )");
@@ -1305,7 +1305,7 @@ from the vertex buffer before advancing to the next value.
 )");
   bool genericEnabled = false;
   DOCUMENT(R"(Only valid for attributes on OpenGL. If the attribute has been set up for integers to
-be converted to floats (glVertexAttribFormat with GL_INT) we store the format as integers. This is
+be converted to floats (``glVertexAttribFormat`` with ``GL_INT``) we store the format as integers. This is
 fine if the application has a float input in the shader it just means we display the raw integer
 instead of the casted float. However if the shader has an integer input this is invalid and it will
 read something undefined - possibly the int bits of the casted float.

renderdoc/api/replay/control_types.h

@@ -127,7 +127,7 @@ struct MeshFormat
 :type: ResourceId
 )");
   ResourceId indexResourceId;
-  DOCUMENT(R"(The offset in bytes where the indices start in idxbuf.
+  DOCUMENT(R"(The offset in bytes where the indices start in :data:`indexResourceId`.
 
 :type: int
 )");
@@ -330,7 +330,7 @@ MeshDisplay()
 MeshDisplay(other: MeshDisplay)
 
 Describes how to render a mesh preview of one or more meshes. Describes the camera configuration as
-well as what options to use when rendering both the current mesh, and any other auxilliary meshes.
+well as what options to use when rendering both the current mesh, and any other auxiliary meshes.
 
 .. data:: NoHighlight
 
@@ -1328,7 +1328,7 @@ struct GPUDevice
 :type: GPUVendor
 )");
   GPUVendor vendor = GPUVendor::Unknown;
-  DOCUMENT(R"(The PCI deviceID of this GPU.
+  DOCUMENT(R"(The PCI device ID of this GPU.
 
 :type: int
 )");

renderdoc/api/replay/d3d12_pipestate.h

@@ -680,7 +680,7 @@ struct OM
 :type: bool
 )");
   bool depthReadOnly = false;
-  DOCUMENT(R"(``True`` if stenncil access to the depth-stencil target is read-only.
+  DOCUMENT(R"(``True`` if stencil access to the depth-stencil target is read-only.
 
 :type: bool
 )");

renderdoc/api/replay/data_types.h

@@ -862,7 +862,7 @@ human-readable name by the application.
 
   DOCUMENT(R"(The chunk indices in the structured file that initialised this resource.
 
-This will at least contain the first call that created it, but may contain other auxilliary calls.
+This will at least contain the first call that created it, but may contain other auxiliary calls.
 
 :type: List[int]
 )");
@@ -937,7 +937,7 @@ struct DescriptorStoreDescription
 )");
   ResourceId resourceId;
 
-  DOCUMENT(R"(For descriptor stores which contain desriptors all of identical size, the size of each
+  DOCUMENT(R"(For descriptor stores which contain descriptors all of identical size, the size of each
 descriptor. Descriptors are assumed to be tightly packed so stride is equal to size.
 
 :type: int
@@ -2639,7 +2639,7 @@ Uuid()
 Uuid(other: Uuid)
 Uuid(word1: int, word2: int, word3: int, word4: int)
 
-A 128-bit Uuid.
+A 128-bit UUID.
 )");
 struct Uuid
 {
@@ -2660,7 +2660,7 @@ struct Uuid
   bool operator<(const Uuid &rhs) const { return words < rhs.words; }
   DOCUMENT("Compares two ``Uuid`` objects for equality.");
   bool operator==(const Uuid &rhs) const { return words == rhs.words; }
-  DOCUMENT(R"(The Uuid bytes as a tuple of four 32-bit integers.
+  DOCUMENT(R"(The UUID bytes as a tuple of four 32-bit integers.
 
 :type: Tuple[int,int,int,int]
 )")
@@ -2925,7 +2925,7 @@ struct ModificationValue
   }
   DOCUMENT(R"(The color value.
 
-If the modifications are for a color target, tthe contents will all be ``0``.
+If the modifications are for a color target, the contents will all be ``0``.
 
 :type: PixelValue
 )");
@@ -3146,7 +3146,7 @@ pixel.
   }
 
   DOCUMENT(R"(Update the depth-test failure state based on known shader output depth value and
-preMod reference value, quantised to a certain number of depth bits with epsilon.
+:data:`preMod` reference value, quantised to a certain number of depth bits with epsilon.
 
 This is primarily used internally and should not be needed to be called externally.
 

renderdoc/api/replay/gl_pipestate.h

@@ -78,8 +78,8 @@ struct VertexAttribute
 
   DOCUMENT(R"(Only valid for integer formatted attributes, ``True`` if they are cast to float.
 
-This is because they were specified with an integer format but glVertexAttribFormat (not
-glVertexAttribIFormat) so they will be cast.
+This is because they were specified with an integer format but ``glVertexAttribFormat`` (not
+``glVertexAttribIFormat``) so they will be cast.
 
 :type: bool
 )");

renderdoc/api/replay/pipestate.h

@@ -188,7 +188,7 @@ public:
 :rtype: bool
 )");
   bool SupportsBarriers() const { return IsCaptureLoaded() && (IsCaptureVK() || IsCaptureD3D12()); }
-  DOCUMENT(R"(Determines whether or not the PostVS data is aligned in the typical fashion (ie.
+  DOCUMENT(R"(Determines whether or not the PostVS data is aligned in the typical fashion (i.e.
 vectors not crossing ``float4`` boundaries). APIs that use stream-out or transform feedback have
 tightly packed data, but APIs that rewrite shaders to dump data might have these alignment
 requirements.

renderdoc/api/replay/renderdoc_replay.h

@@ -191,7 +191,7 @@ inline const WindowingData CreateAndroidWindowingData(ANativeWindow *window)
 typedef void *NSView;
 typedef void *CALayer;
 
-DOCUMENT(R"(Create a :class:`WindowingData` for an metal/opengl-compatible macOS ``CALayer`` handle
+DOCUMENT(R"(Create a :class:`WindowingData` for an Metal/OpenGL-compatible macOS ``CALayer`` handle
 and ``NSView`` handle (as void pointers).
 
 :param NSView view: The native ``NSView`` handle for this window.
@@ -581,7 +581,7 @@ Multiple ranges within the store can be queried at once, and are returned in a c
 
   DOCUMENT(R"(Retrieve the list of possible disassembly targets for :meth:`DisassembleShader`. The
 values are implementation dependent but will always include a default target first which is the
-native disassembly of the shader. Further options may be available for additional diassembly views
+native disassembly of the shader. Further options may be available for additional disassembly views
 or hardware-specific ISA formats.
 
 :param bool withPipeline: More disassembly may be available when a pipeline is specified.
@@ -1214,7 +1214,7 @@ The details of the types of messages that can be received are listed under
 :class:`TargetControlMessage`.
 
 .. note:: If no message has been received, this function will pump the connection. You are expected
-  to continually call this function and process any messages to kee pthe connection alive.
+  to continually call this function and process any messages to keep the connection alive.
 
   This function will block but only to a limited degree. If no message is waiting after a small time
   it will return with a No-op message to allow further processing.
@@ -1378,14 +1378,14 @@ by calling :meth:`EmbedDependenciesIntoCapture`.
 )");
   virtual ResultDetails RemoveDependenciesFromCapture() = 0;
 
-  DOCUMENT(R"(Are there any depdendent files embedded in the capture i.e. shader debug files.
+  DOCUMENT(R"(Are there any dependent files embedded in the capture i.e. shader debug files.
 
 :return: ``True`` if the capture has embedded dependent files, or ``False`` if the capture does not any embedded dependent files.
 :rtype: bool
 )");
   virtual bool HasEmbeddedDependencies() = 0;
 
-  DOCUMENT(R"(Does the capture have references to dependecies i.e. shader debug files.
+  DOCUMENT(R"(Does the capture have references to dependencies i.e. shader debug files.
 
 :return: ``True`` if the capture has references to dependent files, or ``False`` if the capture does not contain references to dependent files.
 :rtype: bool
@@ -1396,7 +1396,7 @@ by calling :meth:`EmbedDependenciesIntoCapture`.
 by the capture i.e. shader debug files.
 
 .. note::
-  The nicknames can be arbitary and do not have to be a filename or a file path.
+  The nicknames can be arbitrary and do not have to be a filename or a file path.
 
 :return: A list of the nicknames used to reference dependencies.
 :rtype: List[str]
@@ -1690,7 +1690,7 @@ microseconds. May be 1.0 if all timestamps and durations are already in microsec
 )");
   virtual double TimestampFrequency() = 0;
 
-  DOCUMENT(R"(Sets the matadata for this capture handle.
+  DOCUMENT(R"(Sets the metadata for this capture handle.
 
 This function may only be called if the handle is 'empty' - i.e. no file has been opened with
 :meth:`OpenFile` or :meth:`OpenBuffer`.
@@ -2120,7 +2120,7 @@ DOCUMENT(R"(When debugging RenderDoc it can be useful to capture itself by doing
 temporary name. This function checks to see if a given self-hosted DLL is available.
 
 :param str dllname: The name of the self-hosted capture module.
-:return: Whether the specified dll is loaded, ready for self-hosted capture.
+:return: Whether the specified DLL is loaded, ready for self-hosted capture.
 :rtype: bool
 )");
 extern "C" RENDERDOC_API bool RENDERDOC_CC RENDERDOC_CanSelfHostedCapture(const rdcstr &dllname);
@@ -2263,7 +2263,7 @@ extern "C" RENDERDOC_API bool RENDERDOC_CC RENDERDOC_IsReleaseBuild();
 
 DOCUMENT(R"(Retrieves the commit hash used to build.
 
-This will be in the form "0123456789abcdef0123456789abcdef01234567"
+This will be in the form ``0123456789abcdef0123456789abcdef01234567``
 
 :return: The commit hash.
 :rtype: str

renderdoc/api/replay/replay_enums.h

@@ -32,7 +32,7 @@ DOCUMENT(R"(The types of several pre-defined and known sections. This allows con
 to recognise and understand the contents of the section.
 
 Note that sections above the highest value here may be encountered if they were written in a new
-version of RenderDoc that addes a new section type. They should be considered equal to
+version of RenderDoc that added a new section type. They should be considered equal to
 :data:`Unknown` by any processing.
 
 .. data:: Unknown
@@ -44,20 +44,20 @@ version of RenderDoc that addes a new section type. They should be considered eq
   This section contains the actual captured frame, in RenderDoc's internal chunked representation.
   The contents can be fetched as structured data with or without replaying the frame.
 
-  The name for this section will be "renderdoc/internal/framecapture".
+  The name for this section will be ``renderdoc/internal/framecapture``.
 
 .. data:: ResolveDatabase
 
   This section contains platform-specific data used to resolve callstacks.
 
-  The name for this section will be "renderdoc/internal/resolvedb".
+  The name for this section will be ``renderdoc/internal/resolvedb``.
 
 .. data:: Bookmarks
 
   This section contains a JSON document with bookmarks added to the capture to highlight important
   events.
 
-  The name for this section will be "renderdoc/ui/bookmarks".
+  The name for this section will be ``renderdoc/ui/bookmarks``.
 
 .. data:: Notes
 
@@ -65,57 +65,57 @@ version of RenderDoc that addes a new section type. They should be considered eq
   details about how the capture was obtained with repro steps in the original program, or with
   driver and machine info.
 
-  The name for this section will be "renderdoc/ui/notes".
+  The name for this section will be ``renderdoc/ui/notes``.
 
 .. data:: ResourceRenames
 
   This section contains a JSON document with custom names applied to resources in the UI, over and
   above any friendly names specified in the capture itself.
 
-  The name for this section will be "renderdoc/ui/resrenames".
+  The name for this section will be ``renderdoc/ui/resrenames``.
 
 .. data:: AMDRGPProfile
 
   This section contains a .rgp profile from AMD's RGP tool, which can be extracted and loaded.
 
-  The name for this section will be "amd/rgp/profile".
+  The name for this section will be ``amd/rgp/profile``.
 
 .. data:: ExtendedThumbnail
 
   This section contains a thumbnail in format other than JPEG. For example, when it needs to be
   lossless.
 
-  The name for this section will be "renderdoc/internal/exthumb".
+  The name for this section will be ``renderdoc/internal/exthumb``.
 
 .. data:: EmbeddedLogfile
 
   This section contains the log file at the time of capture, for debugging.
 
-  The name for this section will be "renderdoc/internal/logfile".
+  The name for this section will be ``renderdoc/internal/logfile``.
 
 .. data:: EditedShaders
 
   This section contains any edited shaders.
 
-  The name for this section will be "renderdoc/ui/edits".
+  The name for this section will be ``renderdoc/ui/edits``.
 
 .. data:: D3D12Core
 
   This section contains an internal copy of D3D12Core for replaying.
 
-  The name for this section will be "renderdoc/internal/d3d12core".
+  The name for this section will be ``renderdoc/internal/d3d12core``.
 
 .. data:: D3D12SDKLayers
 
   This section contains an internal copy of D3D12SDKLayers for replaying.
 
-  The name for this section will be "renderdoc/internal/d3d12sdklayers".
+  The name for this section will be ``renderdoc/internal/d3d12sdklayers``.
 
 .. data:: EmbeddedExternalFiles
 
   This section contains externally referenced files that have been embedded into the capture.
 
-  The name for this section will be "renderdoc/internal/embeddedexternalfiles".
+  The name for this section will be ``renderdoc/internal/embeddedexternalfiles``.
 )");
 enum class SectionType : uint32_t
 {
@@ -1094,7 +1094,7 @@ to apply to multiple related things - see :data:`ClipDistance`, :data:`CullDista
 
 .. data:: GroupIndex
 
-  An input in compute shaders giving a 3D index of this current workgroup amongst all workgroups,
+  An input in compute shaders giving a 3D index of this current workgroup among all workgroups,
   up to the dispatch size.
 
   The index is constant across all threads in the workgroup.
@@ -1136,7 +1136,7 @@ to apply to multiple related things - see :data:`ClipDistance`, :data:`CullDista
 .. data:: DomainLocation
 
   An input to the tessellation evaluation or domain shader, giving the normalised location on the
-  output patch where evaluation is occuring. E.g. for triangle output this is the barycentric
+  output patch where evaluation is occurring. E.g. for triangle output this is the barycentric
   co-ordinates of the output vertex.
 
 .. data:: IsFrontFace
@@ -1814,7 +1814,7 @@ or formats that don't have equal byte-multiple sizes for each channel.
 
 .. data:: PVRTC
 
-  PowerVR properitary texture compression format.
+  PowerVR proprietary texture compression format.
 
 .. data:: A8
 
@@ -2080,32 +2080,32 @@ DOCUMENT(R"(Identifies a particular known tool used for shader processing.
 .. data:: SPIRV_Cross
 
   `SPIRV-Cross <https://github.com/KhronosGroup/SPIRV-Cross>`_
-   targetting normal Vulkan flavoured SPIR-V.
+   targeting normal Vulkan flavoured SPIR-V.
 
 .. data:: SPIRV_Cross_OpenGL
 
   `SPIRV-Cross <https://github.com/KhronosGroup/SPIRV-Cross>`_
-   targetting OpenGL extension flavoured SPIR-V.
+   targeting OpenGL extension flavoured SPIR-V.
 
 .. data:: spirv_dis
 
   `spirv-dis from SPIRV-Tools <https://github.com/KhronosGroup/SPIRV-Tools>`_
-   targetting normal Vulkan flavoured SPIR-V.
+   targeting normal Vulkan flavoured SPIR-V.
 
 .. data:: spirv_dis_OpenGL
 
   `spirv-dis from SPIRV-Tools <https://github.com/KhronosGroup/SPIRV-Tools>`_
-   targetting OpenGL extension flavoured SPIR-V.
+   targeting OpenGL extension flavoured SPIR-V.
 
 .. data:: glslangValidatorGLSL
 
   `glslang compiler (GLSL) <https://github.com/KhronosGroup/glslang>`_
-   targetting normal Vulkan flavoured SPIR-V.
+   targeting normal Vulkan flavoured SPIR-V.
 
 .. data:: glslangValidatorGLSL_OpenGL
 
   `glslang compiler (GLSL) <https://github.com/KhronosGroup/glslang>`_
-   targetting OpenGL extension flavoured SPIR-V.
+   targeting OpenGL extension flavoured SPIR-V.
 
 .. data:: glslangValidatorHLSL
 
@@ -2114,12 +2114,12 @@ DOCUMENT(R"(Identifies a particular known tool used for shader processing.
 .. data:: spirv_as
 
   `spirv-as from SPIRV-Tools <https://github.com/KhronosGroup/SPIRV-Tools>`_
-   targetting normal Vulkan flavoured SPIR-V.
+   targeting normal Vulkan flavoured SPIR-V.
 
 .. data:: spirv_as_OpenGL
 
   `spirv-as from SPIRV-Tools <https://github.com/KhronosGroup/SPIRV-Tools>`_
-   targetting OpenGL extension flavoured SPIR-V.
+   targeting OpenGL extension flavoured SPIR-V.
 
 .. data:: dxcSPIRV
 
@@ -4915,7 +4915,7 @@ DOCUMENT(R"(A set of flags for events that may occur while debugging a shader
 
 .. data:: DebugBreak
 
-  A debugbreak event was emitted.
+  A ``debugbreak()`` event was emitted.
 )");
 enum class ShaderEvents : uint32_t
 {

renderdoc/api/replay/shader_types.h

@@ -924,7 +924,7 @@ struct ShaderVariableChange
   }
 
   DOCUMENT(R"(The value of the variable before the change. If this variable is uninitialised that
-means the variable came into existance on this step.
+means the variable came into existence on this step.
 
 :type: ShaderVariable
 )");

renderdoc/api/replay/vk_pipestate.h

@@ -593,8 +593,8 @@ value.
   bytebuf specializationData;
 
   DOCUMENT(R"(The specialization constant ID for each entry in the specialization constant block of
-reflection info. This corresponds to the constantID in VkSpecializationMapEntry, while the offset
-and size into specializationData can be obtained from the reflection info.
+reflection info. This corresponds to the ``constantID`` in ``VkSpecializationMapEntry``, while the offset
+and size into ``specializationData`` can be obtained from the reflection info.
 
 :type: List[int]
 )")
@@ -857,7 +857,7 @@ and a fragment in none of them is discarded.
 )");
   bool discardRectanglesExclusive = true;
 
-  DOCUMENT(R"(Whether depth clip range is set to [-1, 1] through VK_EXT_depth_clip_control.
+  DOCUMENT(R"(Whether depth clip range is set to ``[-1, 1]`` through ``VK_EXT_depth_clip_control``.
 
 :type: bool
 )");
@@ -1208,8 +1208,8 @@ Describes the setup of a renderpass and subpasses.
 
 .. data:: AttachmentUnused
 
-  Alias for VK_ATTACHMENT_UNUSED, for use by the UI to know when a value in colorAttachmentLocations
-  or colorAttachmentInputIndices is mapped to VK_ATTACHMENT_UNUSED.
+  Alias for ``VK_ATTACHMENT_UNUSED``, for use by the UI to know when a value in ``colorAttachmentLocations``
+  or ``colorAttachmentInputIndices`` is mapped to ``VK_ATTACHMENT_UNUSED``.
 )");
 struct RenderPass
 {
@@ -1329,19 +1329,19 @@ If the list is empty, multiview is disabled and rendering is as normal.
 )");
   rdcarray<uint32_t> multiviews;
 
-  DOCUMENT(R"(If VK_QCOM_fragment_density_map_offset is enabled, contains a list of offsets applied 
+  DOCUMENT(R"(If ``VK_QCOM_fragment_density_map_offset`` is enabled, contains a list of offsets applied 
 to the fragment density map during rendering.
 
-If the list is empty, fdm_offset is disabled and rendering is as normal.
+If the list is empty, ``fdm_offset`` is disabled and rendering is as normal.
 
 :type: List[Offset]
 )");
   rdcarray<Offset> fragmentDensityOffsets;
 
-  DOCUMENT(R"(If VK_EXT_multisampled_render_to_single_sampled is enabled, contains the number of
+  DOCUMENT(R"(If ``VK_EXT_multisampled_render_to_single_sampled`` is enabled, contains the number of
 samples used to render this subpass.
 
-If the subpass is not internally multisampled, tileOnlyMSAASampleCount is set to 0.
+If the subpass is not internally multisampled, ``tileOnlyMSAASampleCount`` is set to 0.
 
 :type: int
 )");

renderdoc/driver/d3d11/d3d11_device.cpp

@@ -1559,7 +1559,7 @@ RDResult WrappedID3D11Device::ReadLogInitialisation(RDCFile *rdc, bool storeStru
   GetReplay()->WriteFrameRecord().frameInfo.initDataSize =
       chunkInfos[(D3D11Chunk)SystemChunk::InitialContents].totalsize;
 
-  RDCDEBUG("Allocating %llu persistant bytes of memory for the log.",
+  RDCDEBUG("Allocating %llu persistent bytes of memory for the log.",
            GetReplay()->WriteFrameRecord().frameInfo.persistentSize);
 
   if(HasFatalError())

renderdoc/driver/d3d12/d3d12_device.cpp

@@ -5710,7 +5710,7 @@ RDResult WrappedID3D12Device::ReadLogInitialisation(RDCFile *rdc, bool storeStru
   GetReplay()->WriteFrameRecord().frameInfo.initDataSize =
       chunkInfos[(D3D12Chunk)SystemChunk::InitialContents].totalsize;
 
-  RDCDEBUG("Allocating %llu persistant bytes of memory for the log.",
+  RDCDEBUG("Allocating %llu persistent bytes of memory for the log.",
            GetReplay()->WriteFrameRecord().frameInfo.persistentSize);
 
   if(m_FatalError != ResultCode::Succeeded)

renderdoc/driver/d3d12/d3d12_resources.cpp

@@ -392,7 +392,7 @@ HRESULT STDMETHODCALLTYPE WrappedID3D12Resource::Map(UINT Subresource,
     map[Subresource].realPtr = (byte *)mapPtr;
     map[Subresource].refcount++;
 
-    // on the first map, register this so we can flush any updates in case it's left persistant
+    // on the first map, register this so we can flush any updates in case it's left persistent
     if(map[Subresource].refcount == 1)
       m_pDevice->Map(this, Subresource);
   }

renderdoc/driver/gl/gl_driver.cpp

@@ -3634,7 +3634,7 @@ RDResult WrappedOpenGL::ReadLogInitialisation(RDCFile *rdc, bool storeStructured
   GetReplay()->WriteFrameRecord().frameInfo.initDataSize =
       chunkInfos[(GLChunk)SystemChunk::InitialContents].totalsize;
 
-  RDCDEBUG("Allocating %llu persistant bytes of memory for the log.",
+  RDCDEBUG("Allocating %llu persistent bytes of memory for the log.",
            GetReplay()->WriteFrameRecord().frameInfo.persistentSize);
 
   return ResultCode::Succeeded;

renderdoc/driver/gl/wrappers/gl_buffer_funcs.cpp

@@ -2254,7 +2254,7 @@ void WrappedOpenGL::glInvalidateBufferSubData(GLuint buffer, GLintptr offset, GL
  *
  *
  *
- * Persistant maps:
+ * Persistent maps:
  *
  * The above process handles "normal" maps that happen between other GL commands that use the buffer
  * contents. Maps that are persistent need to be handled carefully since there are other knock-ons