optionally use KaTeX for csug and release_notes

[Brugarolas]

KaTeX renders LaTeX math ahead-of-time to MathML and/or HTML. Its output is accessible to screen readers and other tools (instead of appearing as ""), and it also does not suffer from the pixelation of math rendered to GIFs.

Also, use scheme.sty and scheme.hsty from stex instead of stale copies with ad-hoc changes.

Depends on dybvig/stex#7

Summary by CodeRabbit

• New Features

  • Enhanced documentation build process with new targets for building specific documentation.
  • Added options for KaTeX integration in documentation.

• Bug Fixes

  • Improved handling of installation paths and cross-platform compatibility.

• Style

  • Introduced new CSS classes for better styling of mathematical expressions and display elements.

• Chores

  • Updated .gitignore to exclude additional files and directories.
  • Removed obsolete files related to Scheme code formatting.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve updates to various files in a project, primarily focusing on enhancing documentation and installation processes. Modifications include updates to the .gitignore file, improvements in makefiles for building documentation, and enhancements to LaTeX configurations for better formatting of Scheme code. Additionally, new CSS classes were introduced for styling, and several obsolete files related to Scheme formatting were removed. The commit identifier for a subproject was also updated.

Changes

File(s)	Change Summary
.gitignore	Updated to ignore additional patterns: *.katex-css-link, /csug/katex/, and /release_notes/katex/.
BUILDING	Added options for make docs, new targets make csug, make release_notes, and sudo make install-docs.
build.zuo	Enhanced run-make function for handling installation directories with new variables.
csug/csug.css, release_notes/releasenotes.css	Added new CSS classes .schemedisplay and .schemedisplay .katex for styling.
csug/csug.stex	Increased \hfuzz parameter from 16.0pt to 26.0pt for LaTeX overflow handling.
csug/csug8.cls	Redefined \scheme and \var commands in theindex and thesummary environments for better formatting.
csug/scheme.hsty, csug/scheme.sty	Removed files containing macros and definitions for formatting Scheme code.
makefiles/Makefile-csug.in, makefiles/Makefile-release_notes.in	Added new variables for installation logic and improved handling of katex resources.
stex	Updated subproject commit identifier from 5e4f0ca67bac448e19a24c09f12fc16d24cd6b6d to 27cddfbf59a48f3f10092e4dd0e450726b6b2e7c.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Makefile
    participant BuildSystem
    participant Documentation

    User->>Makefile: run make docs
    Makefile->>BuildSystem: Check KATEX and KATEX_CSS
    BuildSystem->>Documentation: Build documentation with KaTeX
    Documentation-->>User: Documentation built successfully

Loading

🐰 "In the code where rabbits hop,
New changes make the build non-stop.
With styles and docs, we leap so high,
Ignoring files that make us sigh.
A joyful dance in every line,
For every change, we celebrate and shine!" 🐇

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.