From 0984fccafb9bf27af818146b2b8a419c4b0977b5 Mon Sep 17 00:00:00 2001 From: Marcos Marado Date: Sat, 26 Oct 2024 16:00:49 +0100 Subject: [PATCH] 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. --- CHANGELOG.md | 6 +++--- docs/source/Coding/Changelog.md | 9 ++++++--- docs/source/Components/EvMenu.md | 2 +- docs/source/Components/Web-API.md | 2 +- docs/source/Components/Website.md | 2 +- docs/source/Contribs/Contrib-Clothing.md | 2 +- docs/source/Contribs/Contrib-Godotwebsocket.md | 2 +- docs/source/Contribs/Contrib-Ingame-Reports.md | 2 +- docs/source/Contribs/Contrib-Mapbuilder.md | 2 +- docs/source/Howtos/Web-Character-Generation.md | 8 ++++---- docs/source/Howtos/Web-Help-System-Tutorial.md | 6 +++--- docs/source/Setup/Choosing-a-Database.md | 2 +- docs/source/Setup/Settings.md | 4 ++-- docs/source/index.md | 2 +- evennia/contrib/base_systems/godotwebsocket/README.md | 2 +- evennia/contrib/base_systems/ingame_reports/README.md | 2 +- evennia/contrib/game_systems/clothing/README.md | 2 +- evennia/contrib/grid/mapbuilder/README.md | 2 +- 18 files changed, 31 insertions(+), 28 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index acb085558e..8daaf60675 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -72,7 +72,7 @@ with dynamic keys (rather than just relying on typeclass' key) (Griatch) - [Fix][issue3590]: Make `examine` command properly show `strattr` type Attribute values (Griatch) - [Fix][issue3519]: `GLOBAL_SCRIPTS` container didn't list global scripts not -defined explicitly to be restarted/recrated in settings.py (Griatch) +defined explicitly to be restarted/recrated in `settings.py` (Griatch) - Fix: Passing an already instantiated Script to `obj.scripts.add` (`ScriptHandler.add`) did not add it to the handler's object (Griatch) - [Fix][pull3533]: Fix Lunr search issues preventing finding help entries with similar @@ -142,7 +142,7 @@ underline reset, italic/reset and strikethrough/reset (0xDEADFED5) - [Fix][pull3580]: Fix typo that made `find/loc` show the wrong dbref in result (erratic-pattern) - [Fix][pull3571]: Issue disambiguating between certain partial multimatches (InspectorCaracal) -- [Fix][pull3589]: Fix regex escaping in utils.py for future Python versions (hhsiao) +- [Fix][pull3589]: Fix regex escaping in `utils.py` for future Python versions (hhsiao) - [Docs]: Add True-color description for Colors documentation (0xDEADFED5) - [Docs]: Doc fixes (Griatch, InspectorCaracal, 0xDEADFED5) @@ -1496,7 +1496,7 @@ base-modules where removed from game/gamesrc. Instead admins are encouraged to explicitly create new modules under game/gamesrc/ when they want to implement their game - gamesrc/ is empty by default except for the example folders that contain template files to use for -this purpose. We also added the ev.py file, implementing a new, flat +this purpose. We also added the `ev.py` file, implementing a new, flat API. Work is ongoing to add support for mud-specific telnet extensions, notably the MSDP and GMCP out-of-band extensions. On the community side, evennia's dev blog was started and linked on planet diff --git a/docs/source/Coding/Changelog.md b/docs/source/Coding/Changelog.md index 7013404a56..8daaf60675 100644 --- a/docs/source/Coding/Changelog.md +++ b/docs/source/Coding/Changelog.md @@ -17,6 +17,8 @@ - [Fix][issue3627]: Traceback from contrib `in-game reports` `help manage` command (Griatch) - [Fix][issue3643]: Fix for Commands metaclass interpreting e.g. `usercmd:false()` locks as a `cmd:` type lock for the purposes of default access fallbacks (Griatch). +- [Fix][issue3651]: EvEditor `:j` defaulted to 'full' justify instead of 'left' as + was documented (willmofield) - [Docs][pull3576]: Rework doc for [Pycharm howto][doc-pycharm] - Docs updates: feykrh, Griatch @@ -30,6 +32,7 @@ [pull3640]: https://github.com/evennia/evennia/pull/3640 [pull3647]: https://github.com/evennia/evennia/pull/3647 [pull3635]: https://github.com/evennia/evennia/pull/3635 +[pull3651]: https://github.com/evennia/evennia/pull/3651 [issue3627]: https://github.com/evennia/evennia/issues/3627 [issue3643]: https://github.com/evennia/evennia/issues/3643 [doc-pycharm]: https://www.evennia.com/docs/latest/Coding/Setting-up-PyCharm.html @@ -69,7 +72,7 @@ with dynamic keys (rather than just relying on typeclass' key) (Griatch) - [Fix][issue3590]: Make `examine` command properly show `strattr` type Attribute values (Griatch) - [Fix][issue3519]: `GLOBAL_SCRIPTS` container didn't list global scripts not -defined explicitly to be restarted/recrated in settings.py (Griatch) +defined explicitly to be restarted/recrated in `settings.py` (Griatch) - Fix: Passing an already instantiated Script to `obj.scripts.add` (`ScriptHandler.add`) did not add it to the handler's object (Griatch) - [Fix][pull3533]: Fix Lunr search issues preventing finding help entries with similar @@ -139,7 +142,7 @@ underline reset, italic/reset and strikethrough/reset (0xDEADFED5) - [Fix][pull3580]: Fix typo that made `find/loc` show the wrong dbref in result (erratic-pattern) - [Fix][pull3571]: Issue disambiguating between certain partial multimatches (InspectorCaracal) -- [Fix][pull3589]: Fix regex escaping in utils.py for future Python versions (hhsiao) +- [Fix][pull3589]: Fix regex escaping in `utils.py` for future Python versions (hhsiao) - [Docs]: Add True-color description for Colors documentation (0xDEADFED5) - [Docs]: Doc fixes (Griatch, InspectorCaracal, 0xDEADFED5) @@ -1493,7 +1496,7 @@ base-modules where removed from game/gamesrc. Instead admins are encouraged to explicitly create new modules under game/gamesrc/ when they want to implement their game - gamesrc/ is empty by default except for the example folders that contain template files to use for -this purpose. We also added the ev.py file, implementing a new, flat +this purpose. We also added the `ev.py` file, implementing a new, flat API. Work is ongoing to add support for mud-specific telnet extensions, notably the MSDP and GMCP out-of-band extensions. On the community side, evennia's dev blog was started and linked on planet diff --git a/docs/source/Components/EvMenu.md b/docs/source/Components/EvMenu.md index 8a1342c7ae..01159d0cd8 100644 --- a/docs/source/Components/EvMenu.md +++ b/docs/source/Components/EvMenu.md @@ -501,7 +501,7 @@ See `evennia/utils/evmenu.py` for the details of their default implementations. ## EvMenu templating language -In evmenu.py are two helper functions `parse_menu_template` and `template2menu` that is used to parse a _menu template_ string into an EvMenu: +In `evmenu.py` are two helper functions `parse_menu_template` and `template2menu` that is used to parse a _menu template_ string into an EvMenu: evmenu.template2menu(caller, menu_template, goto_callables) diff --git a/docs/source/Components/Web-API.md b/docs/source/Components/Web-API.md index da4b70e31c..0a11445d0c 100644 --- a/docs/source/Components/Web-API.md +++ b/docs/source/Components/Web-API.md @@ -102,7 +102,7 @@ and static files. - The api code is located in `evennia/web/api/` - the `url.py` file here is responsible for collecting all view-classes. -Contrary to other web components, there is no pre-made urls.py set up for +Contrary to other web components, there is no pre-made `urls.py` set up for `mygame/web/api/`. This is because the registration of models with the api is strongly integrated with the REST api functionality. Easiest is probably to copy over `evennia/web/api/urls.py` and modify it in place. diff --git a/docs/source/Components/Website.md b/docs/source/Components/Website.md index c4dddad948..de784b58cc 100644 --- a/docs/source/Components/Website.md +++ b/docs/source/Components/Website.md @@ -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. ``` diff --git a/docs/source/Contribs/Contrib-Clothing.md b/docs/source/Contribs/Contrib-Clothing.md index 3a5dcf6502..219fee2dcc 100644 --- a/docs/source/Contribs/Contrib-Clothing.md +++ b/docs/source/Contribs/Contrib-Clothing.md @@ -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 diff --git a/docs/source/Contribs/Contrib-Godotwebsocket.md b/docs/source/Contribs/Contrib-Godotwebsocket.md index ffe10e1d68..efdbe67e28 100644 --- a/docs/source/Contribs/Contrib-Godotwebsocket.md +++ b/docs/source/Contribs/Contrib-Godotwebsocket.md @@ -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') diff --git a/docs/source/Contribs/Contrib-Ingame-Reports.md b/docs/source/Contribs/Contrib-Ingame-Reports.md index 20157af3f9..e7958e773e 100644 --- a/docs/source/Contribs/Contrib-Ingame-Reports.md +++ b/docs/source/Contribs/Contrib-Ingame-Reports.md @@ -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 diff --git a/docs/source/Contribs/Contrib-Mapbuilder.md b/docs/source/Contribs/Contrib-Mapbuilder.md index ae18378f24..c2d365f865 100644 --- a/docs/source/Contribs/Contrib-Mapbuilder.md +++ b/docs/source/Contribs/Contrib-Mapbuilder.md @@ -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 diff --git a/docs/source/Howtos/Web-Character-Generation.md b/docs/source/Howtos/Web-Character-Generation.md index e7ef7c823b..98190f6cb8 100644 --- a/docs/source/Howtos/Web-Character-Generation.md +++ b/docs/source/Howtos/Web-Character-Generation.md @@ -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: -* You’ve created a urls.py file in the `mygame/web/chargen` directory +* You’ve 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 @@ -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! \ No newline at end of file +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! diff --git a/docs/source/Howtos/Web-Help-System-Tutorial.md b/docs/source/Howtos/Web-Help-System-Tutorial.md index 37788f963d..116bb35bf5 100644 --- a/docs/source/Howtos/Web-Help-System-Tutorial.md +++ b/docs/source/Howtos/Web-Help-System-Tutorial.md @@ -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: diff --git a/docs/source/Setup/Choosing-a-Database.md b/docs/source/Setup/Choosing-a-Database.md index 630a176cde..65db157449 100644 --- a/docs/source/Setup/Choosing-a-Database.md +++ b/docs/source/Setup/Choosing-a-Database.md @@ -94,7 +94,7 @@ We create a database user 'evennia' and a new database named `evennia` (you can ### Evennia PostgreSQL configuration -Edit `mygame/server/conf/secret_settings.py and add the following section: +Edit `mygame/server/conf/secret_settings.py` and add the following section: ```python # diff --git a/docs/source/Setup/Settings.md b/docs/source/Setup/Settings.md index 766d24281e..afe4abbbfb 100644 --- a/docs/source/Setup/Settings.md +++ b/docs/source/Setup/Settings.md @@ -55,5 +55,5 @@ Apart from the main `settings.py` file, Some other Evennia systems can be customized by plugin modules but has no explicit template in `conf/`: -- *cmdparser.py* - a custom module can be used to totally replace Evennia's default command parser. All this does is to split the incoming string into "command name" and "the rest". It also handles things like error messages for no-matches and multiple-matches among other things that makes this more complex than it sounds. The default parser is *very* generic, so you are most often best served by modifying things further down the line (on the command parse level) than here. -- *at_search.py* - this allows for replacing the way Evennia handles search results. It allows to change how errors are echoed and how multi-matches are resolved and reported (like how the default understands that "2-ball" should match the second "ball" object if there are two of them in the room). \ No newline at end of file +- `cmdparser.py` - a custom module can be used to totally replace Evennia's default command parser. All this does is to split the incoming string into "command name" and "the rest". It also handles things like error messages for no-matches and multiple-matches among other things that makes this more complex than it sounds. The default parser is *very* generic, so you are most often best served by modifying things further down the line (on the command parse level) than here. +- `at_search.py` - this allows for replacing the way Evennia handles search results. It allows to change how errors are echoed and how multi-matches are resolved and reported (like how the default understands that "2-ball" should match the second "ball" object if there are two of them in the room). diff --git a/docs/source/index.md b/docs/source/index.md index ac7c0ad023..1ad026381f 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,6 +1,6 @@ # Evennia Documentation -This is the manual of [Evennia](https://www.evennia.com), the open source Python `MU*` creation system. Use the Search bar on the left to find or discover interesting articles. This manual was last updated October 21, 2024, see the [Evennia Changelog](Coding/Changelog.md). Latest released Evennia version is 4.4.1. +This is the manual of [Evennia](https://www.evennia.com), the open source Python `MU*` creation system. Use the Search bar on the left to find or discover interesting articles. This manual was last updated outubro 26, 2024, see the [Evennia Changelog](Coding/Changelog.md). Latest released Evennia version is 4.4.1. - [Introduction](./Evennia-Introduction.md) - what is this Evennia thing? - [Evennia in Pictures](./Evennia-In-Pictures.md) - a visual overview of Evennia diff --git a/evennia/contrib/base_systems/godotwebsocket/README.md b/evennia/contrib/base_systems/godotwebsocket/README.md index b80068024c..856138577d 100644 --- a/evennia/contrib/base_systems/godotwebsocket/README.md +++ b/evennia/contrib/base_systems/godotwebsocket/README.md @@ -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') diff --git a/evennia/contrib/base_systems/ingame_reports/README.md b/evennia/contrib/base_systems/ingame_reports/README.md index 00c1cbf905..7376390325 100644 --- a/evennia/contrib/base_systems/ingame_reports/README.md +++ b/evennia/contrib/base_systems/ingame_reports/README.md @@ -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 diff --git a/evennia/contrib/game_systems/clothing/README.md b/evennia/contrib/game_systems/clothing/README.md index d84a259f01..d92bdd7b72 100644 --- a/evennia/contrib/game_systems/clothing/README.md +++ b/evennia/contrib/game_systems/clothing/README.md @@ -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 diff --git a/evennia/contrib/grid/mapbuilder/README.md b/evennia/contrib/grid/mapbuilder/README.md index 8a249c9cd6..f2750350b0 100644 --- a/evennia/contrib/grid/mapbuilder/README.md +++ b/evennia/contrib/grid/mapbuilder/README.md @@ -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