Add Command Line Reference to readthedocs #102
Merged
Conversation
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
jkwak-work
approved these changes
May 10, 2025
Contributor
jkwak-work
left a comment
jkwak-work
left a comment
There was a problem hiding this comment.
Looks good to me.
Is the doc going to be updated automatically or periodically when we modify the helpmessage?
Contributor
Author
|
I still need to figure out how this doc will be updated in the future. Since slangc needs to be built beforehand to generate this, it would be ideal to do that somehow in the CI action. Perhaps the CI action can check if the file is up to date during a PR and fail if the author needs to regenerate it, similar to the TOC regeneration, or it could be an automatic update by a bot in an action that only runs on merges to master. |
Contributor
Author
|
I added the regeneration actions in shader-slang/slang#7048 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
For shader-slang/slang#7021
This change adds the slangc command line reference to the ReadTheDocs site, replacing the link to the .md file in the repo.
The current doc is encoded as UTF-16LE, unlike our other docs in UTF-8, and although my other change for this issue (shader-slang/slang#7048) does have a regenerated version in UTF-8, this change also adds a pre-processing step to the RTD build that re-encodes any UTF-16LE doc to UTF-8 just in case.