54320f730c
Move anchor label above function in docs
...
* The anchor label being inside the cpp:function entry seems to break things in
the parameters later
2026-05-15 17:17:52 +01:00
f0b46b5fcf
Include needed jquery dependency for rtd theme
...
* We ship this locally as python 3.6 installs an older sphinx, which doesn't
seem to have this available.
2026-05-15 17:17:52 +01:00
71770e23ed
Use default pygments style for sphinx docs
2026-05-15 17:11:23 +01:00
4bf3fe3019
Fix os.add_dll_directory in docs to use absolute paths
2026-05-15 13:16:08 +01:00
fe0a8c55e6
Add some extra accessors of state to common pipeline state abstraction
2026-05-15 13:16:01 +01:00
bccce17b97
Remove navigation elements on embedded help builds (like htmlhelp)
2026-05-15 13:09:25 +01:00
9897b96196
Remove encoding & embedded js that breaks htmlhelp builder
2026-05-15 13:09:24 +01:00
2811b3874b
Reset sphinx rtd theme to 3.1.0 with no modifications
...
* The next commits will contain our customisations that we still need for chm,
to make it clearer.
2026-05-15 13:09:24 +01:00
1730e6b5af
For callable docstrings allow either std::function or Callback typedef
2026-03-13 13:07:44 +00:00
109e524d5c
Improve cross-module references in docstrings
2026-03-13 13:07:44 +00:00
a3d4f47865
Add correct return type for new functions in API docs
2026-03-05 16:33:52 +00:00
27a5c73163
Add a note to CONTRIBUTING that draft PRs should not be used
2026-03-01 14:27:36 +00:00
a1473c5f84
Improve docstring checking when a class can't be instantiated
...
* Also print warnings for the classes that aren't being checked
2026-02-09 18:05:35 +00:00
fcf298cff9
Implement support for predication on D3D12. Closes #2095
2026-02-04 22:33:57 +00:00
565fe17ba2
Add API and usage documentation for custom annotations system
2026-01-28 14:42:11 +00:00
6c0d1ed057
Fix regenerate stubs script not having proper path separators
2026-01-28 14:42:10 +00:00
ab7e8b0134
Add rule to CONTRIBUTING documentation banning use of LLMs etc
2026-01-26 13:25:21 +00:00
856c838def
Update copyright years to 2026 and fix copyright ranges
...
* In a previous update in 2021 many copyright ranges were truncated
accidentally, and some files have been copy-pasted with wrong years. These
dates have been fixed based on git history and original copyright messages.
2026-01-05 14:17:28 +00:00
94f469de63
Update documentation to account for new mesh viewer options
2025-12-08 18:24:19 +00:00
d89b763e49
Fix issues for Android debugging
2025-12-02 12:37:19 +00:00
466f8f6738
Add documentation for GL shader debugging
2025-12-02 12:37:19 +00:00
dec378eb9b
Remove documentation note about outdated compute shader debug limitation
2025-10-31 15:43:37 +00:00
fb6d4735b3
Do not redeclare __new__ in python stubs
2025-09-11 12:59:22 +01:00
493f4c2ec4
Create output folder when generating python stubs and run from any cwd
...
* Previously it only worked when ran from the docs folder
2025-09-10 15:05:39 +01:00
5957a2710b
Enforce that all docstrings of members have a :type:
2025-09-09 18:57:35 +01:00
b4615dbd18
Add a delayed callback helper for python
2025-09-09 18:57:34 +01:00
c8dc97a34e
Add pixel history to the common feature set
2025-09-04 10:06:14 +01:00
147f010321
Update vulkan version in the docs
2025-09-04 10:05:42 +01:00
29f39f4507
Add VkDescriptorBuffer to documentation index
2025-07-31 01:11:02 +01:00
34c3c40787
Document the PDB search priority/algorithm
...
* This follows PIX's algorithm in most places which although undocumented is
something many people expect to work. It deviates only when there would be
significant performance penalties for little gain.
2025-05-02 10:48:10 +01:00
6ded6187dc
Update python example code using old API member
2025-04-28 11:34:18 +01:00
2322e165de
Update copyright years to 2025
2025-03-14 18:54:37 +00:00
f3129c908c
Clarify renderdoc module vs library for python
2025-02-24 17:19:46 +00:00
32879d6f7c
Update docs to mention both python modules version overrides
2025-02-24 17:19:46 +00:00
1c7a4c24dd
Unwrap staticmethod if necessary when checking python docstrings
...
* Happens on github CI for some reason.
2025-02-11 00:21:39 +00:00
e690587683
Update docs for D3D12 shader debugging
2024-12-20 12:03:34 +00:00
13ba321e4a
Add note to docs about nvidia driver support
2024-12-17 15:33:02 +00:00
8634d8ff22
Add page titles and header texts for all python API ref documentation
...
* Try to guide people looking for an introduction away from API references and
towards actual explanations and documentation.
2024-12-17 14:32:54 +00:00
b76bb49994
Add doc about RT support
2024-12-17 14:32:54 +00:00
7fe2749b38
Add custom D3D12 interface for per-heap descriptor naming by index
2024-12-13 21:19:47 +00:00
dbe18fc7fe
Added ShaderDirectAccess helper struct and ShaderVariable set/get
...
ShaderDirectAccess is used to reference resources which are accessed directly from the Shader (not via a direct binding). Shader resource references using direct binding are stored in ShaderBindIndex.
2024-12-04 08:37:21 +00:00
1c58364627
Update version of nvapi to R560 from github
2024-11-24 00:58:51 +00:00
91c935ffde
Fix verify-docstrings to handle rdcfixedarray tuples
...
* Removes a couple of exceptions from functions it can't verify.
2024-11-18 11:31:12 +00:00
f4d579ffaa
Allow specifying tighter alignment than natural for odd buffer cases
2024-10-30 10:33:40 +00:00
db6e93665f
Make it very clear if someone deletes a required section from template
2024-10-28 10:37:54 +00:00
6408799b5d
Allow specifying scalar pointers in buffer formatter
2024-10-19 01:21:48 +01:00
9ebd796cd8
Remove GGP support
2024-07-08 14:19:42 +01:00
41adeb65b1
Add UI to manage the list of ignored PDBs for callstacks. Closes #3329
2024-06-27 13:54:41 +01:00
2b40a17f8a
Add packing rule for bitfield packing/straddling a la #pragma pack(1)
2024-06-27 13:54:41 +01:00
1ae6882c90
Updated python setup documentation to include instructions for "VS Code"
2024-06-17 10:41:38 +01:00
baldurk