Enable nitpicking in sphinx documentation build and fix some broken refs

renderdoc/api/replay/common_pipestate.h

@@ -612,7 +612,7 @@ descriptors with a secondary counter.
   uint32_t bufferStructCount = 0;
 
   DOCUMENT(R"(The byte size of a single element in the view. Either the byte size of
-:data:`viewFormat`, or the structured buffer element size, as appropriate.
+:data:`format`, or the structured buffer element size, as appropriate.
 
 :type: int
 )");

renderdoc/api/replay/control_types.h

@@ -477,7 +477,7 @@ particular subresource (such as array slice, mip or multi-sampled sample).
 
 .. data:: ResolveSamples
 
-  Value for :data:`sampleIdx` if the samples should be averaged.
+  Value for :data:`Subresource.sample` if the samples should be averaged.
 )");
 struct TextureDisplay
 {

renderdoc/api/replay/renderdoc_replay.h

@@ -408,8 +408,8 @@ well as control the replay and analysis functionality available.
   Not an actual member function - the signature for any ``PreviewWindowCallback`` callbacks.
 
   Called when a preview window could optionally be opened to display some information. It will be
-  called repeatedly with :paramref:`active` set to ``True`` to allow any platform-specific message
-  pumping.
+  called repeatedly with :paramref:`PreviewWindowCallback.active` set to ``True`` to allow any
+  platform-specific message pumping.
 
   :param bool active: ``True`` if a preview window is active/opened, ``False`` if it has closed.
   :return: The windowing data for a preview window, or empty/default values if no window should be
@@ -1068,8 +1068,8 @@ otherwise.
 :param ResourceId buffer: The id of the buffer to use for data. If
   :data:`ConstantBlock.bufferBacked` is ``False`` this is ignored.
 :param int offset: Retrieve buffer contents starting at this byte offset.
-:param int length: Retrieve this many bytes after :paramref:`offset`. May be 0 to fetch the rest of the
-  buffer.
+:param int length: Retrieve this many bytes after :paramref:`GetCBufferVariableContents.offset`.
+  May be 0 to fetch the rest of the buffer.
 :return: The shader variables with their contents.
 :rtype: List[ShaderVariable]
 )");
@@ -2238,7 +2238,7 @@ DOCUMENT(R"(Add a message to RenderDoc's logfile.
   if a debugger is attached, and fatal errors will kill the process after logging.
 :param str project: A short project tag, which should be uppercase and either 3 or 4 characters.
 :param str file: The file where this log message came from.
-:param int line: The line number in :paramref:`file` where this log message came from.
+:param int line: The line number in :paramref:`LogMessage.file` where this log message came from.
 :param str text: The text of the message.
 )");
 extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_LogMessage(LogType type, const rdcstr &project,

renderdoc/api/replay/replay_enums.h

@@ -248,22 +248,22 @@ DOCUMENT(R"(Represents the base type of a shader variable in debugging or consta
 .. data:: ConstantBlock
 
   A reference to a constant block bound to the shader. Variables with this type are stored with
-  opaque contents and should be decoded with :meth:`ShaderVariable.GetBinding`.
+  opaque contents and should be decoded with :meth:`ShaderVariable.GetBindIndex`.
 
 .. data:: ReadOnlyResource
 
   A reference to a read only resource bound to the shader. Variables with this type are stored with
-  opaque contents and should be decoded with :meth:`ShaderVariable.GetBinding`.
+  opaque contents and should be decoded with :meth:`ShaderVariable.GetBindIndex`.
 
 .. data:: ReadWriteResource
 
   A reference to a read/write resource bound to the shader. Variables with this type are stored with
-  opaque contents and should be decoded with :meth:`ShaderVariable.GetBinding`.
+  opaque contents and should be decoded with :meth:`ShaderVariable.GetBindIndex`.
 
 .. data:: Sampler
 
   A reference to a sampler bound to the shader. Variables with this type are stored with opaque
-  contents and should be decoded with :meth:`ShaderVariable.GetBinding`.
+  contents and should be decoded with :meth:`ShaderVariable.GetBindIndex`.
 
 .. data:: Unknown
 
@@ -367,8 +367,8 @@ DOCUMENT(R"(Represents the component type of a channel in a texture or element i
 
 .. data:: Depth
 
-  An opaque value storing depth information, either :data:`floating point <float>` for 32-bit depth
-  values or else :data:`unsigned normalised <UNorm>` for other bit sizes.
+  An opaque value storing depth information, either :data:`Float` for 32-bit depth
+  values or else :data:`UNorm` for other bit sizes.
 
 .. data:: UNormSRGB
 
@@ -2030,7 +2030,7 @@ DOCUMENT(R"(Identifies a shader encoding used to pass shader code to an API.
 .. data:: OpenGLSPIRV
 
   SPIR-V binary shader, as used by OpenGL. This format is technically not distinct from
-  :data:`VulkanSPIRV` but is considered unique here since it really *should* have been a different
+  :data:`SPIRV` but is considered unique here since it really *should* have been a different
   format, and introducing a separation allows better selection of tools automatically.
 
 .. data:: OpenGLSPIRVAsm
@@ -2612,6 +2612,10 @@ DOCUMENT(R"(The stage in a pipeline where a shader runs
 .. data:: Callable
 
   A callable shader, called by shader code via index during ray processing.
+
+.. data:: Invalid
+
+  An invalid/unknown shader stage.
 )");
 enum class ShaderStage : uint8_t
 {
@@ -2644,6 +2648,7 @@ enum class ShaderStage : uint8_t
   Callable,
 
   Count,
+  Invalid = Count,
 };
 
 ITERABLE_OPERATORS(ShaderStage);
@@ -4513,7 +4518,7 @@ DOCUMENT(R"(Specifies a windowing system to use for creating an output window.
 
 .. data:: Xlib
 
-  The windowing data refers to an Xlib window. See :func:`CreateXLibWindowingData`.
+  The windowing data refers to an Xlib window. See :func:`CreateXlibWindowingData`.
 
 .. data:: XCB
 
@@ -4755,7 +4760,7 @@ enum class TextureCategory : uint32_t
 BITMASK_OPERATORS(TextureCategory);
 DECLARE_REFLECTION_ENUM(TextureCategory);
 
-DOCUMENT(R"(A set of flags for ``ShaderStage`` stages
+DOCUMENT(R"(A set of flags for :class:`ShaderStage` stages
 
 .. data:: Unknown
 
@@ -4880,7 +4885,7 @@ DOCUMENT(R"(For a shader stage mask that only covers one shader stage, return th
 
 .. note::
   If the shader stage mask covers multiple stages, only the first matching stage will be returned.
-  If the mask is empty, :data:`ShaderStage.Count` will be returned.
+  If the mask is empty, :data:`ShaderStage.Invalid` will be returned.
 
 :param ShaderStageMask stageMask: The shader stage mask.
 :return: The first shader stage covered by the mask.
@@ -4896,7 +4901,7 @@ constexpr inline ShaderStage FirstStageForMask(ShaderStageMask stageMask)
          : (stageMask & ShaderStageMask::Compute)  ? ShaderStage::Compute
          : (stageMask & ShaderStageMask::Task)     ? ShaderStage::Task
          : (stageMask & ShaderStageMask::Mesh)     ? ShaderStage::Mesh
-                                                   : ShaderStage::Count;
+                                                   : ShaderStage::Invalid;
 }
 
 DOCUMENT(R"(A set of flags for events that may occur while debugging a shader

renderdoc/api/replay/shader_types.h

@@ -659,7 +659,7 @@ Maps the contents of a high-level source variable to one or more shader variable
 A single high-level variable may be represented by multiple mappings but only along regular
 boundaries, typically whole vectors. For example an array may have each element in a different
 mapping, or a matrix may have a mapping per row. The properties such as :data:`rows` and
-:data:`elements` reflect the *parent* object.
+:data:`columns` reflect the *parent* object.
 
 .. note::
 

renderdoc/api/replay/structured_data.h

@@ -1501,7 +1501,7 @@ DOCUMENT(R"(Make a structured object as an enum value.
 
 .. note::
   The enum will be stored just as an integer value, but the string name of the enumeration value can
-  be set with :meth:`SDObject.SetCustomString` if desired.
+  be set by changing the string data member if desired.
 
 :param str name: The name of the object.
 :param int val: The integer value of the enum itself.

renderdoc/api/replay/vk_pipestate.h

@@ -928,7 +928,7 @@ to ``0.0`` to ``1.0``.
   DOCUMENT(R"(The extra size in pixels to increase primitives by during conservative rasterization,
 in the x and y directions in screen space.
 
-See :data:`conservativeRasterizationMode`
+See :data:`conservativeRasterization`
 
 :type: float
 )");