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

update references to develop

Browse source
This commit is contained in:
InspectorCaracal 2023-11-29 20:42:22 -07:00
parent 23038be08f
commit 7164e689c8
4 changed files with 5 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/README.md
View file

@ -245,14 +245,11 @@ The Evennia documentation supports some special reference shortcuts in links:
#### Github online repository #### Github online repository
- `github:` - a shortcut for the full path to the Evennia repository on github. This will refer to - `github:` - a shortcut for the full path to the Evennia repository on github. This will refer to
the `master` branch by default: the `main` branch by default:
[link to objects.py](github:evennia/objects/objects.py) [link to objects.py](github:evennia/objects/objects.py)
This will remap to https://github.com/evennia/evennia/blob/master/evennia/objects/objects.py. This will remap to https://github.com/evennia/evennia/blob/main/evennia/objects/objects.py.
- To refer to the `develop` branch, start the url with `develop/`:
[link to objects.py](github:develop/evennia/objects/objects.py)
#### API #### API

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

@ -51,7 +51,7 @@ As explained on the [Webserver](./Webserver.md) page, the process for getting a
the HTML page requires static resources are requested, the browser will the HTML page requires static resources are requested, the browser will
fetch those separately before displaying it to the user. fetch those separately before displaying it to the user.
If you look at the [evennia/web/](github:develop/evennia/web) directory you'll find the following structure (leaving out stuff not relevant to the website): If you look at the [evennia/web/](github:evennia/web) directory you'll find the following structure (leaving out stuff not relevant to the website):
``` ```
evennia/web/ evennia/web/

2
docs/source/Contribs/Contrib-Character-Creator.md
View file

@ -47,7 +47,7 @@ customize that with the setting `MAX_NR_CHARACTERS`.)
By default, the new `charcreate` command will reference the example menu By default, the new `charcreate` command will reference the example menu
provided by the contrib, so you can test it out before building your own menu. provided by the contrib, so you can test it out before building your own menu.
You can reference You can reference
[the example menu here](github:develop/evennia/contrib/rpg/character_creator/example_menu.py) for [the example menu here](github:evennia/contrib/rpg/character_creator/example_menu.py) for
ideas on how to build your own. ideas on how to build your own.
Once you have your own menu, just add it to your settings to use it. e.g. if your menu is in Once you have your own menu, just add it to your settings to use it. e.g. if your menu is in

3
docs/source/Contributing-Docs.md
View file

@ -148,7 +148,6 @@ These are links to resources outside of the documentation. We also provide some
``` ```
- By using `(github:evennia/objects/objects.py)` as link target, you can point to a place on the Evennia github page (main branch). - By using `(github:evennia/objects/objects.py)` as link target, you can point to a place on the Evennia github page (main branch).
- Use `(github:develop/evennia/objects/objects.py` to target `develop` branch.
- Use `(github:issue)` to point to the github issue-creation page. - Use `(github:issue)` to point to the github issue-creation page.
> Note that if you want to refer to code, it's usually better to [link to the API](#api-links) rather than point to github. > Note that if you want to refer to code, it's usually better to [link to the API](#api-links) rather than point to github.
@ -639,4 +638,4 @@ This is as close to the 'real' version of the docs as you can get locally. The d
[linkdemo]: #Links [linkdemo]: #Links
[retext]: https://github.com/retext-project/retext [retext]: https://github.com/retext-project/retext
[grip]: https://github.com/joeyespo/grip [grip]: https://github.com/joeyespo/grip
[pycharm]: https://www.jetbrains.com/pycharm/ [pycharm]: https://www.jetbrains.com/pycharm/