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

More formatting fixes

Browse source
This commit is contained in:
Griatch 2020-04-10 11:24:05 +02:00
parent d67b300e1e
commit 897c66730f
1 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/README.md
View file

@ -51,7 +51,9 @@ All is done in your terminal/console.
- Next we build the html-based documentation. - Next we build the html-based documentation.
```
make quick make quick
```
- The html-based documentation will appear in the new - The html-based documentation will appear in the new
folder `evennia/docs/build/html/`. Note any errors from files you have edited. folder `evennia/docs/build/html/`. Note any errors from files you have edited.
@ -127,26 +129,26 @@ docs are built by looking at the git tree.
make mv-local make mv-local
``` ```
- Once all is built and it looks ok, run - If you have git-push access to the Evennia `gh-pages` branch on `github`, you
can now deploy.
``` ```
make deploy make deploy
``` ```
Note that this step requires git-push access to the Evennia `gh-pages` branch on `github`. - If you know what you are doing you can also do build + deploy in one step:
If you know what you are doing you can also do
``` ```
make release make release
``` ```
This does the build + deploy steps in one go. After it finishes, the updated - After deployment finishes it finishes, the updated live documentation will be
live documentation will be available at `https://evennia.github.io/evennia/`. available at `https://evennia.github.io/evennia/`.
# Help with editing syntax # Help with editing syntax
> This needs expanding in the future.
## Referring to titles in another file ## Referring to titles in another file
> WIP: Most of these special structures need more work and checking. > WIP: Most of these special structures need more work and checking.