Commit Graph

26 Commits

Author SHA1 Message Date
baldurk 673579e854 Print renderdoc and qrenderdoc module locations 2021-02-14 15:45:57 +00:00
baldurk 321fbdefe9 Don't check docs build consistency if an exception happened 2021-02-14 15:10:21 +00:00
baldurk ea2410fe9f Make new python documentation checks optional
* Older sphinx versions don't have an easy 'objects' property so we just drop
  this check. As long as it happens on CI builds that's the main thing.
2020-12-10 10:05:10 +00:00
baldurk 7ff7e0a71d Replace fixed C arrays with wrapper class in public interface
* These map more naturally to python tuples and are easier to wrap in and out.
* We also tidy up the FloatVecVal etc and standardise the members of
  ShaderValue.
2020-12-09 18:16:08 +00:00
baldurk df6fec13f9 Remove use of automodule in docs
* One automodule in a file for our modules is way too much, so we split it into
  files. Unfortunately this means that only one file can have those classes and
  functions be linkable from elsewhere.
* Instead we bite the bullet and manually curate the items into pages, and at
  the same time subdivide the 'enums and data' page more which is a general
  readability and usability win as well.
* We also add some previously not-included functions, and add a doc-build time
  check to ensure that functions and classes aren't omitted from the
  documentation in future
2020-12-07 17:44:50 +00:00
baldurk a94f238e37 Ensure PersistantConfig member functions are documented 2019-10-09 10:25:49 +01:00
baldurk 14c110ce58 On all platforms, output library to lib folder in cmake build 2019-01-03 12:43:32 +00:00
baldurk fbec9c13aa If sphinx_rtd_theme_chm_friendly directory is missing, use normal theme 2018-08-06 17:28:35 +01:00
baldurk 933c00985d Update documentation for v1.0
* Screenshots and icons are updated to latest style
* Many out-dated references and mentions of support updated.
* Documentation added for new windows like resource inspector and
  performance counter viewer, as well as new features like saving
  bookmarks, resource names.
* Added documentation for Android support as well as OpenGL ES support.
2018-02-25 23:27:13 +00:00
baldurk 2bd35f87ff Remove python modindex file from docs 2018-02-16 09:41:16 +00:00
baldurk 16f64a5ace Remove use of unnecessary swig generated .py wrappers
* These .py wrappers are relevant for the non-builtin path, but since we
  use -builtin they serve no purpose except to make things more complex.
* So instead we make the module directly exported as 'module' instead of
  '_module'.
* On windows there's no conflict because we have renderdoc.dll vs
  renderdoc.pyd. On linux it's librenderdoc.so vs renderdoc.so.
* To prevent supporting files like .lib / .pdb from conflicting on
  windows we build the python modules into a subdirectory. They're not
  ever used by the UI (it links in the bindings directly).
2017-12-25 15:05:28 +00:00
baldurk fd66995ac2 Let docs build pick release or development built modules 2017-12-21 21:19:49 +00:00
baldurk 8d5a621ee1 Re-enable python API docs 2017-12-15 17:33:55 +00:00
baldurk 2460bc998d Add sphinx_paramlinks extension and use :paramref:`` to reference params 2017-12-15 17:33:53 +00:00
baldurk fc61918b89 Update sphinx_rtd_theme (keeping our local changes) 2017-05-15 10:52:43 +01:00
baldurk b4ed02d040 Take out the python API from the docs index until qrenderdoc ships 2017-05-15 10:21:20 +01:00
baldurk 94e64a0aec Add build of renderdoc python modules for documentation generation 2017-04-19 18:07:55 +01:00
baldurk dd75707157 Set copyright year to current year at build time 2017-04-18 14:57:45 +01:00
baldurk 5adce29b44 Add support for documenting bindings API directly in code 2017-04-18 14:57:41 +01:00
baldurk f9b78a9312 Configure sphinx to require 1.5 for building htmlhelp
* This version contains the fix for sphinx-doc/sphinx#2550 so we want to
  assume it is present and tidy up all the external links. However if
  needed (and you don't care about the external links being broken) you
  can locally remove this version requirement.
2016-09-27 15:13:46 +02:00
baldurk 0d8762befb Change htmlhelp_basename 2016-05-15 21:34:05 +02:00
baldurk bd2e10d438 Remove reference to non-existant _static folder, fixes warning 2016-05-15 21:34:03 +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
Matthäus G. Chajdas c04dd86d8d Initial commit of new restructuredtext docs 2016-05-15 21:33:51 +02:00