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

Grammar changes in docs

Browse source
This commit is contained in:
telimektar3 2022-02-14 10:25:16 -05:00
parent f0f80a39a0
commit 1aae246401
2 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -4,4 +4,4 @@ Evennia utilizes GitHub for issue tracking and contributions:
- Reporting Issues issues/bugs and making feature requests can be done [in the issue tracker](https://github.com/evennia/evennia/issues). - Reporting Issues issues/bugs and making feature requests can be done [in the issue tracker](https://github.com/evennia/evennia/issues).
- Evennia's documentation is a [wiki](https://github.com/evennia/evennia/wiki) that everyone can contribute to. Further - Evennia's documentation is a [wiki](https://github.com/evennia/evennia/wiki) that everyone can contribute to. Further
instructions and details about contributing is found [here](https://github.com/evennia/evennia/wiki/Contributing). instructions and details about contributing are found [here](https://github.com/evennia/evennia/wiki/Contributing).

24
docs/README.md
View file

@ -30,7 +30,7 @@ use a system with `make` (Linux/Unix/Mac or [Windows-WSL][Windows-WSL]). Lacking
in principle also run the sphinx build-commands manually - read the `evennia/docs/Makefile` to see in principle also run the sphinx build-commands manually - read the `evennia/docs/Makefile` to see
which commands are run by `make`. which commands are run by `make`.
You don't necessarily _have_ to build the docs locally to contribute. But You don't necessarily _have_ to build the docs locally to contribute, but
building them allows you to check for yourself that syntax is correct and that building them allows you to check for yourself that syntax is correct and that
your change comes out looking as you expected. your change comes out looking as you expected.
@ -38,7 +38,7 @@ your change comes out looking as you expected.
If you only want to build the main documentation pages (not the API autodocs), If you only want to build the main documentation pages (not the API autodocs),
you don't need to install Evennia itself, only the documentation resources. you don't need to install Evennia itself, only the documentation resources.
All is done in your terminal/console. This action is done in your terminal/console.
- (Optional, but recommended): Activate a virtualenv with Python 3.7. - (Optional, but recommended): Activate a virtualenv with Python 3.7.
- `cd` to into the `evennia/docs` folder (where this README is). - `cd` to into the `evennia/docs` folder (where this README is).
@ -64,7 +64,7 @@ All is done in your terminal/console.
## Building the main documentation and API docs ## Building the main documentation and API docs
The full documentation includes both the doc pages and the API documentation The full documentation includes both the doc pages and the API documentation
generated from the Evennia source. For this you must install Evennia and generated from the Evennia source. To build the full documentation you must install Evennia and
initialize a new game with a default database (you don't need to have it initialize a new game with a default database (you don't need to have it
running). running).
@ -116,8 +116,8 @@ repo with
### Building with another gamedir ### Building with another gamedir
If you for some reason want to use another location of your `gamedir/`, or want it If for some reason you want to use another location of your `gamedir/` or want it
named something else (maybe you already use the name 'gamedir' for your development ...), named something else (maybe you already use the name 'gamedir' for your development ...)
you can do so by setting the `EVGAMEDIR` environment variable to the absolute path you can do so by setting the `EVGAMEDIR` environment variable to the absolute path
of your alternative game dir. For example: of your alternative game dir. For example:
@ -130,7 +130,7 @@ of your alternative game dir. For example:
The full Evennia documentation also tracks documentation from older Evennia The full Evennia documentation also tracks documentation from older Evennia
versions. This is done by pulling documentation from Evennia's old release versions. This is done by pulling documentation from Evennia's old release
branches and building them all so readers can choose which one to view. Only branches and building them all so readers can choose which one to view. Only
specific official Evennia branches will be built, so you can't use this to specific official Evennia branches will be built so you can't use this to
build your own testing branch. build your own testing branch.
- All local changes must have been committed to git first, since the versioned - All local changes must have been committed to git first, since the versioned
@ -173,8 +173,8 @@ We generally use underscores for italics and double-asterisks for bold:
## Headings ## Headings
We use `#` to indicate sections/headings. The more `#` the more of a sub-heading it is (will get smaller We use `#` to indicate sections/headings. The more `#` the more of a sub-heading it is (the font will be smaller
and smaller font). and smaller).
- `# Heading` - `# Heading`
- `## SubHeading` - `## SubHeading`
@ -305,7 +305,7 @@ Everything within these backticks will be verbatim.
## Code blocks ## Code blocks
Code examples are a special case - we want them to get code-highlighting for readability. This is done by using Code examples are a special case - we want them to get code-highlighting for readability. This is done by using
the triple-backticks and specify which language we use: the triple-backticks and specifying the language we use:
```` ````
```python ```python
@ -346,7 +346,7 @@ This is important because it is!
#### Warning #### Warning
A warning block is used to draw attention to particularly dangerous things, or features easy to A warning block is used to draw attention to particularly dangerous things or features that are easy to
mess up. mess up.
```` ````
@ -357,7 +357,7 @@ Be careful about this ...
#### Version changes and deprecations #### Version changes and deprecations
These will show up as one-line warnings that suggest an added, changed or deprecated These will show up as one-line warnings that suggest an added, changed or deprecated
feature beginning with particular version. feature beginning with the particular version.
```` ````
```{versionadded} 1.0 ```{versionadded} 1.0
@ -378,7 +378,7 @@ feature beginning with particular version.
#### Sidebar #### Sidebar
This will display an informative sidebar that floats to the side of regular content. This is useful This will display an informative sidebar that floats to the side of regular content. This is useful
for example to remind the reader of some concept relevant to the text. to remind the reader of some concept relevant to the text.
```` ````
```{sidebar} Things to remember ```{sidebar} Things to remember