From 39c9e25f6d728e970b68a9452330e754991b4ac5 Mon Sep 17 00:00:00 2001 From: aidanfnv Date: Wed, 14 May 2025 09:41:59 -0700 Subject: Make Command Line Reference readthedocs compatible (#7048) This change modifies the code that generates the Command Line Reference doc to output H2 headings in place of H1 headings, and H3 in place of existing H2, so that readthedocs will not treat the additional H1 headings as titles. This change also regenerates the Command Line Reference doc, as the current copy in the repo appears to be quite out-of-date. The existing copy is also encoded as UTF-16LE, whereas the other docs are all UTF-8. The regenerated doc is also UTF-8, and all I did to generate that was run slangc.exe -help-style markdown -h > docs\command-line-slangc-reference.md 2>&1 after building slangc on Windows. This change also adds GitHub actions workflows to check the contents of the doc, fail if a regenerated version needs to be checked in, and provide an option to regenerate it with a bot, all in a similar manner to User Guide TOC regeneration. The doc writer was producing different results from my local build until I changed how the writer sorts the shader stages. In the action, the order of pixel and fragment was reversed, despite the only difference from my local build being the OS. --------- Co-authored-by: slangbot Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com> --- docs/command-line-slangc-reference.md | Bin 78686 -> 44397 bytes 1 file changed, 0 insertions(+), 0 deletions(-) (limited to 'docs') diff --git a/docs/command-line-slangc-reference.md b/docs/command-line-slangc-reference.md index 36493b2f9..9f5295470 100644 Binary files a/docs/command-line-slangc-reference.md and b/docs/command-line-slangc-reference.md differ -- cgit v1.2.3