* // WIP convert header docs to doxygen style
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
* Adjust reference syntax
From ":cpp:func:`Foo::bar`" to "\ref Foo::bar". This seems to pacify some build warnings and clean up the C++ docs a little, but it doesn't seem to improve issue #1265
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
* Expose documentation for FileRules, Config, MatrixTransform::setOffset
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
* Expose more documentation: Looks, Context Variables
Minor cleanup and adjustments
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
* Expose GpuShaderCreator usage example
Promote usage example up to the class-wide documentation
Change numbered list to simple bullets -- there seems to be a problem with orderedlists...?
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
* Missed a change
Signed-off-by: Patrick Hodoul <Patrick.Hodoul@autodesk.com>
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
* Expose `GpuShaderDesc` fragment shader example code
Not sure why the topmost "border" forward slashes are not rendering...
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
* Tidy up conversion to doxygen style
Specify language for code demonstrations
Improve readability of header comments
Clean up "TODO" comments re: moving to rst
Convert remaining comments to RST syntax
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
* Rebuild frozen docs
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
* Adjust line wrapping in one particularly egregious instance
Signed-off-by: Zach Lewis <zachcanbereached@gmail.com>
Co-authored-by: Patrick Hodoul <Patrick.Hodoul@autodesk.com>
* Restructure Python bindings, Complete PyGpuShaderDesc
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Update frozen docs
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Hide PySystemMonitors symbols
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Fix Python 2 CI failure
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Remove extra sys import
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Fix issue 1278, GroupTransform docs
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Update GroupTransform frozen docs
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Clean up PyGroupTransform class
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Update PyGroupTransform.write, PyConfig.__repr__
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Refactor PyCPUProcessor buffer handling
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Install/require NumPy for Python tests
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Document NumPy dependency, fix installation link
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Fix CMake include, Update frozen docs
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Make NumPy optional, improve docs
Signed-off-by: Michael Dolan <michdolan@gmail.com>
Co-authored-by: Patrick Hodoul <patrick.hodoul@autodesk.com>
* Move AppHelpers to core
Following up on the request from a recent TSC meeting, this PR moves the App Helpers code into the core library. This adds no new third-party dependencies. (The App Helpers code is intended to simplify the work of integrating OCIO into a real-world DCC application.) Also, following up on another suggestion, the ViewingPipeline class was renamed LegacyViewingPipeline.
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Forgot to remove function declaration
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Add python exposure
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Fixing the build with DOC. Still have to update the rst doc files.
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Add filtering options to app helpers as described in issue 1222
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Fix merge issue
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Add missing destructor
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* cast issue
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
Co-authored-by: doug-walker <43830961+doug-walker@users.noreply.github.com>
* CDLTransform cleanup
Rework CDLTranform interface to implement the proposal made in issue #1155.
CDLTransform can be created from a file and an id.
Files containing several CDL (such as ccc and cdl) can be loaded as GroupTransform to give a way to check the content of such CDLs.
Functions to get/set ID should be replaced by calls on the transform's formatMetadata.
Functions to get/set description have been renamed and documention has been added to explain how formatMetadata can be used.
FormatMetadata has helper functions to get/set common attributes 'name' and 'id'.
Write related functions have been moved to GroupTransform so that a processor does not have to be create to write a transform.
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Missing override keyword
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* FormatMetadata::addChildElement does not return a value, call to back() should have been removed with the return statement.
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Update RST files
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Revert rst files that have only white space changes or windows related changes
Signed-off-by: Bernard Lefebvre <bernard.lefebvre@autodesk.com>
* Rework API docs and dependencies
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Refine doc generation
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Add frozendoc module for freezing autodoc RST
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Split Python docs between src and frozen
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Add expandvars extension for namespace handling
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Add frozen RST comparison tools
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Improve frozen docs error msg
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Update frozen docs and implement CI test
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Update frozen RST
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Add file diff debug output to diagnose CI failures
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Refine diff debug code
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Add handling for error tolerances when comparing RST
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Include diff in logs, support windoes paths
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Move diff to log, conform path slashes
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Fix warnings, debug windows Python path
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Debug Windows configure file
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Move conf.py configure_file to own statement
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Move path setup to cmake module, print debug messages
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Prevent overwiring configured conf.py
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Debug frozen doc comparison
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Debug RST freeze on Windows
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Debug all RST lines on Windows
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Raise exceptions caught in freeze extension
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Debug windows frozendoc steps
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Fix frozendoc encoding on windows
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Clean up doc configuration
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Disable frozen docs test on macOS and Windows
Signed-off-by: Michael Dolan <michdolan@gmail.com>
* Update frozen API docs
Signed-off-by: Michael Dolan <michdolan@gmail.com>
