Skip to content

Add dedicated docs section for managing the Octave executable#274

Merged
blink1073 merged 1 commit into
Calysto:mainfrom
blink1073:improve-octave-executable-docs
Mar 9, 2026
Merged

Add dedicated docs section for managing the Octave executable#274
blink1073 merged 1 commit into
Calysto:mainfrom
blink1073:improve-octave-executable-docs

Conversation

@blink1073
Copy link
Copy Markdown
Contributor

@blink1073 blink1073 commented Mar 9, 2026

Summary

  • Adds a new "Managing the Octave Executable" section to README.rst, placed between "Supported Platforms" and "Troubleshooting"
  • Documents the executable resolution order (config trait → OCTAVE_EXECUTABLEoctave on PATH → octave-cli on PATH → Flatpak fallback)
  • Covers custom executable configuration via env var and octave_kernel_config.py
  • Adds Windows-specific path guidance for Octave 5+
  • Explains Flatpak/Snap auto-detection and the Snap-specific temp directory
  • Describes startup validation behavior and points to python -m octave_kernel.check

Test plan

  • Read through the new section and verify accuracy against kernel.py logic
  • Confirm RST renders correctly (doc8 passes in pre-commit)

Documents the executable resolution order, how to set a custom
executable via env var or config file, Windows-specific path notes,
Flatpak/Snap auto-detection behavior, and startup validation.
@blink1073 blink1073 enabled auto-merge (squash) March 9, 2026 19:58
@blink1073 blink1073 merged commit d3948cb into Calysto:main Mar 9, 2026
25 checks passed
@blink1073 blink1073 deleted the improve-octave-executable-docs branch March 10, 2026 00:14
@blink1073 blink1073 mentioned this pull request Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant