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

@ -21,7 +21,7 @@ Would result in this added description:
## Installation
To install, import this module and have your default character
inherit from ClothedCharacter in your game's characters.py file:
inherit from ClothedCharacter in your game's `characters.py` file:
```python

View file

@ -9,7 +9,7 @@ You can use Godot to provide advanced functionality with proper Evennia support.
## Installation
You need to add the following settings in your settings.py and restart evennia.
You need to add the following settings in your `settings.py` and restart evennia.
```python
PORTAL_SERVICES_PLUGIN_MODULES.append('evennia.contrib.base_systems.godotwebsocket.webclient')

View file

@ -77,7 +77,7 @@ The contrib is designed to make adding new types of reports to the system as sim
#### Update your settings
The contrib optionally references `INGAME_REPORT_TYPES` in your settings.py to see which types of reports can be managed. If you want to change the available report types, you'll need to define this setting.
The contrib optionally references `INGAME_REPORT_TYPES` in your `settings.py` to see which types of reports can be managed. If you want to change the available report types, you'll need to define this setting.
```python
# in server/conf/settings.py

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