fix: remove erroneous links from the documentation

Sphinx assumes that WORD.py should be a link to https://WORD.py .

This is not a problem in most of the documentation, since Sphinx won't
turn those python filenames into links when they are wrapped in
backticks, like `WORD.py`. Unfortunately, not always that was being
done, and so there were several wrong, broken links in the
documentation.

This patch wraps all the occurrences I've found of this case with
backticks, not only making the documentation more readible and
homogeneous, but more importantly getting rid of those unwanted links
in the generated HTML version of the documentation.
This commit is contained in:
Marcos Marado 2024-10-26 16:00:49 +01:00
parent 88afac2874
commit 0984fccafb
18 changed files with 31 additions and 28 deletions

View file

@ -86,7 +86,7 @@ For example:
Below are two examples showcasing the use of automatic exit generation and
custom exit generation. Whilst located, and can be used, from this module for
convenience The below example code should be in mymap.py in mygame/world.
convenience The below example code should be in `mymap.py` in mygame/world.
### Example One