docs: docs GHA workflow + overaul testshade, oslquery, osltoy docs#2134
Open
lgritz wants to merge 1 commit into
Open
docs: docs GHA workflow + overaul testshade, oslquery, osltoy docs#2134lgritz wants to merge 1 commit into
lgritz wants to merge 1 commit into
Conversation
Add a docs.yml workflow to build the docs. Triggered when we push branches or submit PRs that change them. How did we not have this before? Convert OSLQuery docs from docdeep to doxygen+markdown. We had a cobbled together thing called "docdeep" that would scrape comments from a header file (like oslquery.h) in a "poor man's doxygen" style, producing "Markdeep", and turning it into HTML. I can barely justify that now, especially after having moved all the rest of the OSL docs to Readthedocs years ago. So just go ahead and convert it all to the standard approach we are using for the rest of the OSL docs, to appear on RTD with the rest. Also change the testshade and osltoy docs from markdeep to markdown and just bundle them into our regular OSL documentation as will appear on Readthedocs. Assisted-by: Claude Code / sonnet-4.6 Signed-off-by: Larry Gritz <lg@larrygritz.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a docs.yml workflow to build the docs. Triggered when we push branches or submit PRs that change them to rebuild the docs (and make them available as a downloadable artifact that people can check even if they can't build the docs on their local machine). How did we not have this before?
Convert OSLQuery docs from docdeep to doxygen+markdown. We had a cobbled together thing called "docdeep" that would scrape comments from a header file (like oslquery.h) in a "poor man's doxygen" style, producing "Markdeep", and turning it into HTML. I can barely justify that now, especially after having moved all the rest of the OSL docs to Readthedocs years ago. So just go ahead and convert it all to the standard approach we are using for the rest of the OSL docs, to appear on RTD with the rest.
Also change the testshade and osltoy docs from markdeep to markdown and just bundle them into our regular OSL documentation as will appear on Readthedocs.
Assisted-by: Claude Code / sonnet-4.6