baldurk
ed38da72ab
Add writeups of each example
2026-08-13 21:05:11 +01:00
baldurk
ec5cd1f049
Add new python examples, also available embedded into UI
2026-08-13 21:05:11 +01:00
baldurk
11b83f2272
Remove old python documentation, ready for replacement
2026-08-13 21:05:11 +01:00
baldurk
eb27bd34bf
Rename python shell to python scripting window in docs
2026-08-13 21:05:11 +01:00
baldurk
d4130ce42a
Enable nitpicking in sphinx documentation build and fix some broken refs
2026-08-13 17:46:49 +01:00
baldurk
173510cc8d
Re-organise in-application API docs to have sections & better type docs
...
* We create proper docs for all the types we reference, some were omitted or
implicit as 'notes' in parameters.
2026-08-13 17:46:49 +01:00
baldurk
7a1233e17e
Fix some python warnings in docs config & docstring checker
2026-08-13 17:46:48 +01:00
baldurk
bb4017a965
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.
2026-08-13 17:46:47 +01:00
baldurk
5e462c5ebe
Add type hints to python for class constructors
...
* We enforce default and copy constructors where possible, this isn't very
pythonic but we can't use copy.deepcopy on our types.
* The structs that have specialised constructors e.g. FloatVector or Subresource
also have those documented though we have no way to enforce it.
2026-08-13 17:46:47 +01:00
baldurk
950568fb8f
Rename previous/next to previousAction/nextAction in ActionDescription
...
* swig internally creates 'next' member which we normally want to avoid, so
prevent shadowing here by using a distinct name.
2026-08-13 17:46:47 +01:00
baldurk
40945e6e8a
Explicitly note that MiniQtHelper callbacks are optional
2026-08-13 17:46:47 +01:00
baldurk
3f653cfbf2
Remove RENDERDOC_GetDefaultCaptureOptions, initialise in constructor
2026-08-13 17:46:46 +01:00
baldurk
db75eec620
Expose capture connection windows to python scripting
2026-08-13 17:46:46 +01:00
baldurk
ce8941150f
Don't print overload per optional parameter in sphinx documentation
2026-08-13 17:46:45 +01:00
baldurk
87825d3d64
Handle and check for default values in docstrings for verify-docstrings
2026-08-13 17:46:45 +01:00
baldurk
16a24406b2
In python extensions, set pyrenderdoc global before calling register()
2026-08-13 17:46:44 +01:00
baldurk
10272fa35b
Make most extension json fields optional
...
* We require `extension_api` and `version` fields in case needed for future
compatibility
2026-08-13 17:46:44 +01:00
baldurk
f9035e1c42
Assign enum value __doc__ attributes as python interpreter doesn't
2026-08-13 17:46:43 +01:00
baldurk
c15a5c2c66
Add os.add_dll_directory cruft to verify-docstrings
2026-08-13 17:46:39 +01:00
baldurk
26a84363b8
Embed stubsgen.py and automatically generate stubs into user folder
...
* We create both a stubs folder for each specific version, and a 'latest' that
is updated by newer RD versions.
* For development, the stubs will be regenerated any time the git commit hash
changes for development builds.
2026-08-13 17:46:39 +01:00
baldurk
9223971536
Remove old stubs generation code and replace with our own script
...
* This is smaller and easier to maintain, and adds functionality like resolving
circular dependencies to be able to import the stubs as-is on python 3.6+
2026-08-13 17:46:38 +01:00
baldurk
8d6d307998
Don't apply sphinx paramlinks to Callable[] lines
2026-08-13 17:46:38 +01:00
baldurk
64c942c68a
Include license and readme for sphinxcontrib-jquery
2026-08-05 10:52:06 +01:00
baldurk
a66becd518
Add missing documentation item
2026-07-21 16:59:52 +01:00
Kirill Kozlov
39ecdedcc1
Fix code snippet in the fetch_shader.rst
...
Make it the same as in the fetch_shader.py
2026-06-30 20:53:42 +09:00
baldurk
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
baldurk
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
baldurk
71770e23ed
Use default pygments style for sphinx docs
2026-05-15 17:11:23 +01:00
baldurk
4bf3fe3019
Fix os.add_dll_directory in docs to use absolute paths
2026-05-15 13:16:08 +01:00
baldurk
fe0a8c55e6
Add some extra accessors of state to common pipeline state abstraction
2026-05-15 13:16:01 +01:00
baldurk
bccce17b97
Remove navigation elements on embedded help builds (like htmlhelp)
2026-05-15 13:09:25 +01:00
baldurk
9897b96196
Remove encoding & embedded js that breaks htmlhelp builder
2026-05-15 13:09:24 +01:00
baldurk
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
baldurk
1730e6b5af
For callable docstrings allow either std::function or Callback typedef
2026-03-13 13:07:44 +00:00
baldurk
109e524d5c
Improve cross-module references in docstrings
2026-03-13 13:07:44 +00:00
baldurk
a3d4f47865
Add correct return type for new functions in API docs
2026-03-05 16:33:52 +00:00
baldurk
27a5c73163
Add a note to CONTRIBUTING that draft PRs should not be used
2026-03-01 14:27:36 +00:00
baldurk
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
baldurk
fcf298cff9
Implement support for predication on D3D12. Closes #2095
2026-02-04 22:33:57 +00:00
baldurk
565fe17ba2
Add API and usage documentation for custom annotations system
2026-01-28 14:42:11 +00:00
baldurk
6c0d1ed057
Fix regenerate stubs script not having proper path separators
2026-01-28 14:42:10 +00:00
baldurk
ab7e8b0134
Add rule to CONTRIBUTING documentation banning use of LLMs etc
2026-01-26 13:25:21 +00:00
baldurk
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
baldurk
94f469de63
Update documentation to account for new mesh viewer options
2025-12-08 18:24:19 +00:00
baldurk
d89b763e49
Fix issues for Android debugging
2025-12-02 12:37:19 +00:00
baldurk
466f8f6738
Add documentation for GL shader debugging
2025-12-02 12:37:19 +00:00
baldurk
dec378eb9b
Remove documentation note about outdated compute shader debug limitation
2025-10-31 15:43:37 +00:00
baldurk
fb6d4735b3
Do not redeclare __new__ in python stubs
2025-09-11 12:59:22 +01:00
baldurk
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
baldurk
5957a2710b
Enforce that all docstrings of members have a :type:
2025-09-09 18:57:35 +01:00
baldurk