Commit Graph

128 Commits

Author SHA1 Message Date
baldurk 8bc80b41b0 Various improvements/tweaks/missing bits/extra links
* General proof-reading pass on the new docs, so some of these issues
  are old and just haven't been noticed before.
2016-05-16 20:01:15 +02:00
baldurk 3146b905b5 Remove unneeded toctree:: statements in non-index pages 2016-05-16 18:35:39 +02:00
baldurk 4691972148 Document the actual exported API entry point, RENDERDOC_GetAPI 2016-05-16 17:02:46 +02:00
baldurk aa3bd8a674 Add convenience to docs make.sh to also call hhc.exe to build the .chm 2016-05-16 16:33:32 +02:00
baldurk 29f1d1af62 Add post-processing for the sphinx htmlhelp output before build
* Copies our .hhk into the build folder
* Removes TOC entries that just refer to anchors - it's unnecessary and
  just clutters up the TOC.
2016-05-16 16:29:08 +02:00
baldurk afc5c81d4c Update the .hhk file with a hand-authored more useful index 2016-05-16 15:56:22 +02:00
baldurk 4a90373458 Add an anchor for the tip about using RenderDoc as an image viewer 2016-05-16 15:42:53 +02:00
baldurk e922e85aa3 Add a reference to where unstripped shader info is detailed 2016-05-16 15:42:42 +02:00
baldurk 6c24932746 Vulkan support is no longer planned for future! 2016-05-16 15:42:28 +02:00
baldurk 440c9c4569 Move in application API to root level 2016-05-16 14:43:46 +02:00
baldurk 2b59a806cf Remove header from API page 2016-05-16 14:39:06 +02:00
baldurk f0f5d84f25 Add documentation for capture window 2016-05-16 13:39:07 +02:00
baldurk e1c63c9561 Fill out the text on the options window page 2016-05-16 13:20:03 +02:00
baldurk df9025cc8f Add text to texture viewer documentation page 2016-05-16 12:58:23 +02:00
baldurk e610e1e175 Add autobuilt hhk, to customise for future chm builds 2016-05-15 21:42:57 +02:00
baldurk a29bed7a5b Refer to images under correct paths 2016-05-15 21:34:06 +02:00
baldurk 0d8762befb Change htmlhelp_basename 2016-05-15 21:34:05 +02:00
baldurk 1e8967a862 Fix some enumerator definitions that referenced ranges of enums 2016-05-15 21:34:04 +02:00
baldurk bd2e10d438 Remove reference to non-existant _static folder, fixes warning 2016-05-15 21:34:03 +02:00
baldurk d1e04e0374 Add a make.sh based on the make.bat 2016-05-15 21:34:02 +02:00
baldurk e53f50ce03 A couple of FAQ questions not properly header'd 2016-05-15 21:34:01 +02:00
baldurk 81a1b2e020 Add syntax highlighting 2016-05-15 21:34:00 +02:00
baldurk f298b81ad2 Tweak index page a bit 2016-05-15 21:34:00 +02:00
baldurk 7e35a63e17 Copy and modify sphinx_rtdtheme for use 2016-05-15 21:33:59 +02:00
baldurk d06e81e1c2 Tweak html display - better title, no source links 2016-05-15 21:33:58 +02:00
baldurk a26205381f Remove unneeded version 2016-05-15 21:33:57 +02:00
baldurk 1e1516420a build into Documentation folder by default 2016-05-15 21:33:56 +02:00
Matthäus G. Chajdas 4bb04c6dae Fix broken link and some missing emphasis. 2016-05-15 21:33:55 +02:00
Matthäus G. Chajdas f124f3f389 Port the remaining pages where I know how to style them. 2016-05-15 21:33:54 +02:00
Matthäus G. Chajdas 6557cec9ea Fix various internal links. 2016-05-15 21:33:53 +02:00
Matthäus G. Chajdas f04f016a99 Remove "other resources" to flatten the hierarchy a bit. 2016-05-15 21:33:52 +02:00
Matthäus G. Chajdas 925f33bfb5 Add all How do I ...? pages. 2016-05-15 21:33:52 +02:00
Matthäus G. Chajdas c04dd86d8d Initial commit of new restructuredtext docs 2016-05-15 21:33:51 +02:00
baldurk 6f8e0ae391 Remove old sandcastle documentation 2016-05-15 21:33:50 +02:00
baldurk f40afe5792 Renaming Attaching.png -> Injecting.png 2016-05-14 20:55:18 +02:00
baldurk 5f6884c6b9 Remove copy-pasted wrong enum in API docs 2016-05-12 18:53:56 +02:00
baldurk b14b771000 Document the in-application API properly 2016-04-23 11:36:17 +02:00
baldurk e59ee3fcd9 Update credits with recent contributors 2016-04-23 09:27:27 +02:00
baldurk a2cde0a8ea Update API example in Tips & Tricks documentation page 2016-04-23 09:27:09 +02:00
baldurk 15b963fd47 Add documentation for unstripped-path-specifying code 2016-03-06 15:09:45 +01:00
baldurk 8bf41ab8c9 Add Vulkan to documentation where relevant. 2016-02-09 22:39:22 +01:00
baldurk 11ea496c3d Add credits of individuals who helped with Vulkan work 2016-02-09 21:52:04 +01:00
baldurk e3c7abe0ee Add link to great presentation in documentation & README 2016-01-20 20:13:48 +01:00
baldurk 5de056135a We need to require GL_ARB_buffer_storage as well as EXT_dsa 2015-07-23 23:10:53 +02:00
baldurk 65a3ed0df0 Document that pixel history events show up in the timeline bar 2015-07-19 00:44:37 +02:00
baldurk 9eb1ccc1f5 Document recently added option (from last version - oops) 2015-07-19 00:44:26 +02:00
baldurk 6975997413 Couple of minor fixes 2015-07-19 00:36:22 +02:00
baldurk 03d5e1e659 Change mentions of 'attaching' to 'injecting' to distinguish it 2015-07-19 00:27:46 +02:00
baldurk 72845bedf7 Update pixel debugging with more up to date information 2015-07-19 00:27:06 +02:00
baldurk cc831f0714 Update OpenGL status - it's a bit better now :). 2015-07-19 00:10:12 +02:00