docs: Drop the memray3.N entry point

With `scikit-build-core`, we don't have any way to produce an entry
point script called `memray3.N` (where `3.N` is the Python version
Memray was installed for). Drop references to it from the docs.

Signed-off-by: Matt Wozniski <[email protected]>

Author: godlygeek

docs/examples/README.rst

@@ -11,11 +11,11 @@ Make sure you install the required dependencies by running
 directory. The examples below use the project in the ``mandelbrot`` folder, but
 you can use the same instructions to launch the other examples as well.
 
-To track memory allocations, invoke ``memray3.9 run``:
+To track memory allocations, invoke ``memray run``:
 
 .. code:: shell
 
-   memray3.9 run mandelbrot/mandelbrot.py
+   memray run mandelbrot/mandelbrot.py
 
 Memray will print a message displaying the output file it creates.
 
@@ -28,7 +28,7 @@ graph, use the following command:
 
 .. code:: shell
 
-   memray3.9 flamegraph mandelbrot/memray-mandelbrot.py.187967.bin
+   memray flamegraph mandelbrot/memray-mandelbrot.py.187967.bin
 
 The HTML file for the flame graph will be generated under
 ``mandelbrot/memray-flamegraph-mandelbrot.py.187967.html``. The flame graph

docs/getting_started.rst

@@ -26,19 +26,13 @@ You can invoke Memray the following way:
 
   python3.9 -m memray
 
-Or alternatively through the version-qualified ``memrayX.Y`` script:
-
-.. code:: shell
-
-  memray3.9
-
-You can also invoke Memray without version-qualifying it:
+Or alternatively through the ``memray`` script:
 
 .. code:: shell
 
   memray
 
-The downside to the unqualified ``memray`` script is that it's not immediately
+The downside to using the ``memray`` script is that it's not immediately
 clear what Python interpreter will be used to execute Memray. If you're using
 a virtual environment that's not a problem because you know exactly what interpreter is
 in use, but otherwise you need to be careful to ensure that ``memray`` is
@@ -56,7 +50,7 @@ To run memray on the ``example.py`` script, use :doc:`the run subcommand <run>`.
 
 .. code:: shell
 
-  memray3.9 run example.py
+  memray run example.py
 
 This will execute the script and track its memory allocations, displaying the name of the file where results are being recorded with a message like:
 
@@ -72,7 +66,7 @@ the results file:
 
 .. code:: shell
 
-  memray3.9 flamegraph memray-example.py.4131.bin
+  memray flamegraph memray-example.py.4131.bin
 
 This will generate the ``memray-flamegraph-example.py.4131.html`` file in the current directory. See the :doc:`flamegraph`
 documentation which explains how to interpret flame graphs.

docs/run.rst

@@ -140,15 +140,15 @@ You can run a program in live mode using ``run --live``:
 
 .. code:: shell
 
-  memray3.9 run --live application.py
+  memray run --live application.py
 
 Immediately Memray will start your application in the background and will run a TUI in the foreground that you can use
 to analyze your application's memory usage. If you don't want to run your program in the background, you can instead
 use ``run --live-remote``:
 
 .. code:: shell
 
-  memray3.9 run --live-remote application.py
+  memray run --live-remote application.py
 
 In this mode, Memray will choose an unused port, bind to it, and display a message saying:
 
@@ -160,7 +160,7 @@ It will wait for you to run:
 
 .. code:: shell
 
-   memray3.9 live <port>
+   memray live <port>
 
 in another terminal window to attach to it. Regardless of whether you choose to use one terminal or two, the resulting
 TUI is exactly the same. See :doc:`live` for details on how to interpret and control the TUI.

news/673.removal.rst

@@ -0,0 +1 @@
+Memray no longer provides an entry point named ``memray3.N`` (where "3.N" is the Python version that Memray was installed for). You can use ``python3.N -m memray`` instead.