Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: remove erroneous links from the documentation

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/Components/Website.md
View file

@ -104,7 +104,7 @@ This is the layout of the `mygame/web/` folder relevant for the website:
Game folders created with older versions of Evennia will lack most of this
convenient `mygame/web/` layout. If you use a game dir from an older version,
you should copy over the missing `evennia/game_template/web/` folders from
there, as well as the main urls.py file.
there, as well as the main `urls.py` file.
```