Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 14:26:30 +01:00
Code Issues 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

6
docs/source/Howtos/Web-Help-System-Tutorial.md
View file

@ -62,10 +62,10 @@ At this point, our new *app* contains mostly empty files that you can explore.
### Create a view
A *view* in Django is a simple Python function placed in the "views.py" file in your app. It will
A *view* in Django is a simple Python function placed in the `views.py` file in your app. It will
handle the behavior that is triggered when a user asks for this information by entering a *URL* (the connection between *views* and *URLs* will be discussed later).
So let's create our view. You can open the "web/help_system/views.py" file and paste the following lines:
So let's create our view. You can open the `web/help_system/views.py` file and paste the following lines:
```python
from django.shortcuts import render
@ -108,7 +108,7 @@ Here's a little explanation line by line of what this template does:
### Create a new URL
Last step to add our page: we need to add a *URL* leading to it... otherwise users won't be able to access it. The URLs of our apps are stored in the app's directory "urls.py" file.
Last step to add our page: we need to add a *URL* leading to it... otherwise users won't be able to access it. The URLs of our apps are stored in the app's directory `urls.py` file.
Open the `web/help_system/urls.py` file (you might have to create it) and make it look like this: