Issue in the installation documentation

[sevmag]

Description

The installation commands currently generated by the quick-start widget use the unquoted format: pip3 install -e .[extras]. (also in the current fix proposed in #862 )

On macOS (where Zsh is the default shell) and other systems using Zsh, square brackets are interpreted as globbing/pattern-matching characters. This causes the installation to fail immediately with the following error:
zsh: no matches found: .[develop]

Proposed Fix

The installation target needs to be wrapped in double quotes. This makes the command "shell-safe," ensuring it works correctly across Zsh, Bash, and PowerShell.

Changes required in quick-start.html:

1. Update the all appearances of the .[extras] and wrap in quotes:

graphnet/docs/source/installation/quick-start.html

Line 152 in 737646e

$("#command pre").text("pip3 install -e .[develop]");

fix:

$("#command pre").text("pip3 install -e \".[develop]\"");

graphnet/docs/source/installation/quick-start.html

Line 157 in 737646e

var installLine = "pip3 install -e .[" + extrasPrefix + "]";

fix:

var installLine = "pip3 install -e \".[" + extrasPrefix + "]\"";

These changes are still valid for the updated code in #862 at the time of writing

[Aske-Rosted]

Hey @sevmag could you be convinced to write a PR for this? Seems like you already have a specific fix in mind. 😄