Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-29 03:57:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Minor cleanup in contributing-docs page

Browse source
This commit is contained in:
Griatch 2020-10-31 19:50:51 +01:00
parent 826db5aae5
commit a37375acdf
1 changed files with 4 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -15,31 +15,10 @@ the [Markdown][commonmark] syntax. See [the syntax section below](#Editing-synta
## Source file structure
The sources are organized into several rough categories, with only a few administrative documents
at the root of `evennia/docs/source/`. The folders are named in singular form since they will
primarily be accessed as link refs (e.g. `Component/Account`)
For v 0.9.5, the sources are all together under `evennia/docs/source/`. The main files are all
Markdown (`.md`) files.
- `source/Components/` are docs describing separate Evennia building blocks, that is, things
that you can import and use. This extends and elaborates on what can be found out by reading
the api docs themselves. Example are documentation for `Accounts`, `Objects` and `Commands`.
- `source/Concepts/` describes how larger-scale features of Evennia hang together - things that
can't easily be broken down into one isolated component. This can be general descriptions of
how Models and Typeclasses interact to the path a message takes from the client to the server
and back.
- `source/Setup/` holds detailed docs on installing, running and maintaining the Evennia server and
the infrastructure around it.
- `source/Coding/` has help on how to interact with, use and navigate the Evennia codebase itself.
This also has non-Evennia-specific help on general development concepts and how to set up a sane
development environment.
- `source/Contribs/` holds documentation specifically for packages in the `evennia/contribs/` folder.
Any contrib-specific tutorials will be found here instead of in `Howtos`
- `source/Howtos/` holds docs that describe how to achieve a specific goal, effect or
result in Evennia. This is often on a tutorial or FAQ form and will refer to the rest of the
documentation for further reading.
- `source/Howtos/Starting/` holds all documents part of the initial tutorial sequence.
Other files and folders:
Other files and folders:
- `source/api/` contains the auto-generated API documentation as `.rst` files. Don't edit these
files manually, your changes will be lost. To refer to these files, use `api:` followed by
the Python path, for example `[rpsystem contrib](api:evennia.contrib.rpsystem)`.
@ -162,7 +141,7 @@ well. We won't touch that.)
If you for some reason want to use another location of your `gamedir/`, or want it
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
of your alternative game dir. For example:
of your alternative game dir. For example (bash):
```
EVGAMEDIR=/my/path/to/mygamedir make local
@ -682,7 +661,6 @@ extension
to understand our friendly Google-style docstrings used in classes and functions etc.
[sphinx](https://www.sphinx-doc.org/en/master/)
[recommonmark](https://recommonmark.readthedocs.io/en/latest/index.html)
[commonmark](https://spec.commonmark.org/current/)