Michael Dolan
647b3e68b8
* 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>
47 lines
1.0 KiB
ReStructuredText
47 lines
1.0 KiB
ReStructuredText
..
|
|
SPDX-License-Identifier: CC-BY-4.0
|
|
Copyright Contributors to the OpenColorIO Project.
|
|
|
|
Rules
|
|
=====
|
|
|
|
FileRules
|
|
*********
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Python
|
|
|
|
.. include:: python/${PYDIR}/pyopencolorio_filerules.rst
|
|
|
|
.. group-tab:: C++
|
|
|
|
.. doxygenclass:: ${OCIO_NAMESPACE}::FileRules
|
|
:members:
|
|
:undoc-members:
|
|
|
|
.. doxygenfunction:: ${OCIO_NAMESPACE}::operator<<(std::ostream&, const FileRules&)
|
|
|
|
.. doxygentypedef:: ${OCIO_NAMESPACE}::ConstFileRulesRcPtr
|
|
.. doxygentypedef:: ${OCIO_NAMESPACE}::FileRulesRcPtr
|
|
|
|
ViewingRules
|
|
************
|
|
|
|
.. tabs::
|
|
|
|
.. group-tab:: Python
|
|
|
|
.. include:: python/${PYDIR}/pyopencolorio_viewingrules.rst
|
|
|
|
.. group-tab:: C++
|
|
|
|
.. doxygenclass:: ${OCIO_NAMESPACE}::ViewingRules
|
|
:members:
|
|
:undoc-members:
|
|
|
|
.. doxygenfunction:: ${OCIO_NAMESPACE}::operator<<(std::ostream&, const ViewingRules&)
|
|
|
|
.. doxygentypedef:: ${OCIO_NAMESPACE}::ConstViewingRulesRcPtr
|
|
.. doxygentypedef:: ${OCIO_NAMESPACE}::ViewingRulesRcPtr
|