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>
54 lines
2.0 KiB
C
54 lines
2.0 KiB
C
// SPDX-License-Identifier: BSD-3-Clause
|
|
// Copyright Contributors to the OpenColorIO Project.
|
|
|
|
/*
|
|
This file's format is adaped from pybind11_mkdoc by Wenzel Jakob, released
|
|
under The MIT License.
|
|
|
|
See:
|
|
https://github.com/pybind/pybind11_mkdoc/blob/master/pybind11_mkdoc/mkdoc_lib.py
|
|
|
|
This header is used as a stand-in for a generated docstrings.h when
|
|
'OCIO_BUILD_PYTHON=ON' and 'OCIO_BUILD_DOCS=OFF'. All 'DOC()' calls in the
|
|
Python bindings will return an empty string.
|
|
|
|
-----------------------------------------------------------------------------
|
|
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2020 Wenzel Jakob
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
|
|
-----------------------------------------------------------------------------
|
|
*/
|
|
|
|
#define DOC(...) __doc_none
|
|
|
|
#if defined(__GNUG__)
|
|
#pragma GCC diagnostic push
|
|
#pragma GCC diagnostic ignored "-Wunused-variable"
|
|
#endif
|
|
|
|
static const char *__doc_none = R"doc()doc";
|
|
|
|
#if defined(__GNUG__)
|
|
#pragma GCC diagnostic pop
|
|
#endif
|