AcademySoftwareFoundation / OpenColorIO

A color management framework for visual effects and animation.
https://opencolorio.org
BSD 3-Clause "New" or "Revised" License
1.79k stars 455 forks source link

Docs issue 2009 #2063

Closed czerouni closed 1 month ago

czerouni commented 1 month ago

This attempts to address issue 2009, however it's not really possible to do the things requested there because of limitations of the Sphinx theme used.

So instead this cleans up and extends the documentation for contributing to the docs. It also fixes a few Sphinx warnings. And it recreates a new set of frozen .rst files from the code. That modified several files and deleted many more, which reduced the number of Sphinx warning dramatically.

carolalynn commented 1 month ago

Hey @czerouni - thanks for this! I have some questions on the content, but also, we required signed commits (commit -s) to acknowledge the DCO. So you'll need to:

git commit --amend -s
git push <your_remote_fork_name> <your_branch_name> --force
czerouni commented 1 month ago

I don't know git well enough to go back and sign those old commits. So I am going to close this PR, create a new fork, and just do a single commit with the changes (and deal with the conflicts at the same time). Then open a new PR for that.