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

@ -56,7 +56,7 @@ After this, we will get into defining our *models* (the description of the datab
### Installing - Checkpoint:
* you should have a folder named `chargen` or whatever you chose in your mygame/web/ directory
* you should have your application name added to your INSTALLED_APPS in settings.py
* you should have your application name added to your INSTALLED_APPS in `settings.py`
## Create Models
@ -350,7 +350,7 @@ urlpatterns = [
### URLs - Checkpoint:
* Youve created a urls.py file in the `mygame/web/chargen` directory
* Youve created a `urls.py` file in the `mygame/web/chargen` directory
* You have edited the main `mygame/web/urls.py` file to include urls to the `chargen` directory.
## HTML Templates
@ -416,7 +416,7 @@ This page should show a detailed character sheet of their application. This will
### create.html
Our create HTML template will use the Django form we defined back in views.py/forms.py to drive the majority of the application process. There will be a form input for every field we defined in forms.py, which is handy. We have used POST as our method because we are sending information to the server that will update the database. As an alternative, GET would be much less secure. You can read up on documentation elsewhere on the web for GET vs. POST.
Our create HTML template will use the Django form we defined back in views.py/forms.py to drive the majority of the application process. There will be a form input for every field we defined in `forms.py`, which is handy. We have used POST as our method because we are sending information to the server that will update the database. As an alternative, GET would be much less secure. You can read up on documentation elsewhere on the web for GET vs. POST.
```html
<!-- file mygame/web/chargen/templates/chargen/create.html-->
@ -546,4 +546,4 @@ And you should put it at the bottom of the page. Just before the closing body w
{% endblock %}
```
Reload and open [http://localhost:4001/chargen/create](http://localhost:4001/chargen/create/) and you should see your beautiful CAPCHA just before the "submit" button. Try not to check the checkbox to see what happens. And do the same while checking the checkbox!
Reload and open [http://localhost:4001/chargen/create](http://localhost:4001/chargen/create/) and you should see your beautiful CAPCHA just before the "submit" button. Try not to check the checkbox to see what happens. And do the same while checking the checkbox!

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: