Skip to content

Commit 6886e4f

Browse files
committed
[GR-24925] Replace relative links with absolute to avoid broken links on other domains.
PullRequest: graalpython/1223
2 parents be9da6c + 2160768 commit 6886e4f

File tree

6 files changed

+28
-28
lines changed

6 files changed

+28
-28
lines changed

docs/user/FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ can expect to see between 0.1x and 0.5x performance.
4747

4848
### I heard languages with JIT compilers have slow startup. Is that true for GraalVM's Python?
4949

50-
It depends. When you use the [GraalVM Native Image](https://www.graalvm.org/docs/reference-manual/graalvm-native-image/) feature with Python or
50+
It depends. When you use the [GraalVM Native Image](https://www.graalvm.org/reference-manual/native-image/) feature with Python or
5151
use the `graalpython` launcher of GraalVM, its startup is competitive with
5252
CPython. In any case, both with Native Image or when running on JVM you first
5353
need to warm up to reach peak performance. This is a complicated story in

docs/user/Interoperability.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ print("Here is what we found: '%s'" % md[1])
7373

7474
To run it, pass the `--jvm --polyglot` options to `graalpython` binary:
7575
```shell
76-
$ graalpython --jvm --polyglot polyglot_example.py
76+
graalpython --jvm --polyglot polyglot_example.py
7777
```
7878

7979
This example matches Python strings using the JavaScript regular expression object
@@ -85,7 +85,7 @@ Python, and use R again to display the resulting data image, using both R and
8585
Python libraries in conjunction. To run it, first install the
8686
required R library:
8787
```shell
88-
$ R -e 'install.packages("https://www.rforge.net/src/contrib/jpeg_0.1-8.tar.gz", repos=NULL)'
88+
R -e 'install.packages("https://www.rforge.net/src/contrib/jpeg_0.1-8.tar.gz", repos=NULL)'
8989
```
9090

9191
This example also uses [image_magix.py](http://graalvm.org/docs/examples/image_magix.py) and works
@@ -179,5 +179,5 @@ print(java.is_function(my_list.add))# prints True, the add method of ArrayList
179179
print(java.instanceof(my_list, ArrayList)) # prints True
180180
```
181181

182-
See the [Polyglot Programming](https://www.graalvm.org/docs/reference-manual/polyglot-programming/) and the [Embed Languages](https://www.graalvm.org/docs/reference-manual/embed-languages/#Function_Python) reference
182+
See the [Polyglot Programming](https://www.graalvm.org/docs/reference-manual/polyglot-programming/) and the [Embed Languages](https://www.graalvm.org/reference-manual/embed-languages/) reference
183183
for more information about interoperability with other programming languages.

docs/user/Jython.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,4 +175,4 @@ For Graal Python, no dependency other than on the [GraalVM SDK](https://mvnrepos
175175
required. There are no APIs particular to Python that are exposed, and
176176
everything is done through the GraalVM API. Important to know is that as long as
177177
your application is executed on a GraalVM with the Python language installed,
178-
you can embed Python in your programs. For more detail, refer to the [Embed Languages](https://www.graalvm.org/docs/reference-manual/embed-languages/#Function_Python) reference.
178+
you can embed Python in your programs. For more detail, refer to the [Embed Languages](https://www.graalvm.org/reference-manual/embed-languages/) reference.

docs/user/Packages.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ environment. This generates wrapper scripts and makes the implementation usable
66
from shell as standard Python interpreter. To do so execute the following from a
77
GraalVM installation:
88

9-
```
9+
```shell
1010
graalpython -m venv <venv-dir>
1111
```
1212

1313
To activate the environment in your shell session call:
1414

15-
```
15+
```shell
1616
source <venv-dir>/bin/activate
1717
```
1818

@@ -23,13 +23,13 @@ simple module to install packages is provided (including
2323
potential patches required for those packages). Try the following to find out
2424
more:
2525

26-
```
26+
```shell
2727
graalpython -m ginstall --help
2828
```
2929

3030
As a slightly more exciting example, try:
3131

32-
```
32+
```shell
3333
graalpython -m ginstall install numpy
3434
```
3535

docs/user/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ questions about this implementation.
1010
## Installing Python
1111

1212
Python can be added to the GraalVM installation with the [GraalVM Updater](https://www.graalvm.org/docs/reference-manual/gu/), `gu`, tool:
13-
```
14-
$ gu install python
13+
```shell
14+
gu install python
1515
```
1616
The above command will install a community version of a component from GitHub catalog.
1717
For GraalVM Enterprise users, the [manual component installation](https://www.graalvm.org/docs/reference-manual/gu/#manual-installation) is required. See `bin/gu --help` for more information.
@@ -21,8 +21,8 @@ For GraalVM Enterprise users, the [manual component installation](https://www.gr
2121
GraalVM implementation of Python targets Python 3.7 compatibility. While support
2222
for the Python language is still limited, you can run simple Python scripts or
2323
commands with the `graalpython` binary.
24-
```
25-
$ graalpython [options] [-c cmd | filename]
24+
```shell
25+
graalpython [options] [-c cmd | filename]
2626
```
2727

2828
If no program file or command is given, you are dropped into a simple REPL.
@@ -31,8 +31,8 @@ GraalVM supports some of the same options as Python 3.7 and some additional
3131
options to control the underlying Python implementation, the GraalVM tools
3232
and the execution engine. These can be viewed using the following command:
3333

34-
```
35-
$ graalpython --help --help:tools --help:languages
34+
```shell
35+
graalpython --help --help:tools --help:languages
3636
```
3737

3838
## Installing Supported Packages
@@ -45,21 +45,21 @@ incompatible interaction with the local user's packages that may have been
4545
installed using a system installation of CPython:
4646

4747
```shell
48-
$ graalpython -m venv my_new_venv
49-
$ source my_new_venv/bin/activate
48+
graalpython -m venv my_new_venv
49+
source my_new_venv/bin/activate
5050
```
5151

5252
To see the list of installable packages, run:
5353

5454
```shell
55-
$ graalpython -m ginstall install --help
55+
graalpython -m ginstall install --help
5656
```
5757

5858
This will print a short help including a comma-separated list of packages you
5959
can install. The installation works as described in that help:
6060

6161
```shell
62-
$ graalpython -m ginstall install pandas
62+
graalpython -m ginstall install pandas
6363
```
6464

6565
Note that when using the GraalVM implementation of Python from Java, the

docs/user/Tooling.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ about tools currently supported on Python.
88
### Debugger
99
To enable debugging, pass the `--inspect` option to the `graalpython`
1010
launcher. For example:
11-
```
12-
$ graalpython --inspect -c "breakpoint(); import os; os.exit()"
11+
```shell
12+
graalpython --inspect -c "breakpoint(); import os; os.exit()"
1313
Debugger listening on port 9229.
1414
To start debugging, open the following URL in Chrome:
1515
chrome-devtools://devtools/bundled/js_app.html?ws=127.0.1.1:9229/76fcb6dd-35267eb09c3
@@ -26,8 +26,8 @@ the `graalpython --help:tools` command line help for more details on how to use
2626
it. In order to work better with existing Python code, we also partially support
2727
the standard library `trace` module with this low-overhead GraalVM coverage
2828
instrument. So you can do this:
29-
```
30-
$ graalpython -m trace -m -c -s my_script.py
29+
```shell
30+
graalpython -m trace -m -c -s my_script.py
3131
```
3232
This will work similarly to how it will run on CPython. The programmatic API
3333
also works, with some limitations. For example, it does not currently track calls,
@@ -37,13 +37,13 @@ only line counts and called functions.
3737
The `_lsprof` built-in module has been implemented using the GraalVM `cpusampler`
3838
tool. Not all profiling features are currently supported, but basic profiling
3939
works:
40-
```
41-
$ graalpython -m cProfile -s sort -m ginstall --help
40+
```shell
41+
graalpython -m cProfile -s sort -m ginstall --help
4242
```
4343
The interactive exploration of a stats output file also works:
44-
```
45-
$ graalpython -m cProfile -o ginstall.profile -m ginstall --help
46-
$ graalpython -m pstats ginstall.profile
44+
```shell
45+
graalpython -m cProfile -o ginstall.profile -m ginstall --help
46+
graalpython -m pstats ginstall.profile
4747
ginstall.profile%
4848
callers
4949
[...]

0 commit comments

Comments
 (0)