4 Commits
Author SHA1 Message Date
brkglvn01andRémi Achard 6dec6b23a7 Updated documentation as 3D LUTs can now be inverted (#1812)
* Fix documentation build (#1809)

* Fix documentation build on Doxygen 1.9.7

Signed-off-by: Rémi Achard <remiachard@gmail.com>

* Remove doxygen group names

Signed-off-by: Rémi Achard <remiachard@gmail.com>

* Remove remaining doxygen group

Signed-off-by: Rémi Achard <remiachard@gmail.com>

---------

Signed-off-by: Rémi Achard <remiachard@gmail.com>
Signed-off-by: Brooke <beg9562@rit.edu>

* Updated documentation as 3D LUTs can now be inverted

Signed-off-by: Brooke <brkglvn@gmail.com>
Signed-off-by: Brooke <beg9562@rit.edu>

---------

Signed-off-by: Rémi Achard <remiachard@gmail.com>
Signed-off-by: Brooke <beg9562@rit.edu>
Signed-off-by: Brooke <brkglvn@gmail.com>
Co-authored-by: Rémi Achard <remiachard@gmail.com>
2023-07-13 20:45:22 -04:00
Michael Dolan 647b3e68b8 API Docs Implementation (#1197)
* 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>
2020-12-09 00:28:25 -05:00
doug-walker 5e4d7bc27c Adsk Contrib - Reorganize and add new documentation (#1096)
* Reorganize and add new documentation

Signed-off-by: Doug Walker <Doug.Walker@autodesk.com>

* Suggestions from Michael and Thomas

Signed-off-by: Doug Walker <Doug.Walker@autodesk.com>
2020-08-11 14:23:41 -04:00
Sean Cooper 3757d95872 initial v2 doc restructure (#1075)
* initial doc restructure

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* rename file to avoid conflict

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* rename directory to avoid conflict`

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* fix readme

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* add images back

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* add python dependencies

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* remove min version

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* add find_python_package

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* update dependencies

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* add python2 blocking to doc generation

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* add local pip install pythonpath

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* remove recommonmark

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* add min version

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* reduce python dependencies
modify python macro to support dependencies

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* update dependencies

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* update python pip prefix

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* swap to original sphinx-press-theme

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* reconfigure docs target dependencies

Signed-off-by: Sean Cooper <sean@seancooper.xyz>

* temporarily disable windows docs builds

Signed-off-by: Sean Cooper <sean@seancooper.xyz>
2020-07-31 13:42:28 -04:00