Refactor 1.0 docs with new toctree structure and inheritance
This commit is contained in:
parent
62477eac50
commit
628afe9367
142 changed files with 3967 additions and 3024 deletions
|
|
@ -1,14 +1,11 @@
|
|||
|
||||
```{warning}
|
||||
|
||||
This is the **WIP** documentation of the
|
||||
development branch of Evennia (v1.0-dev). The text is based on the
|
||||
original Evennia `wiki <https://github.com.evennia/evennia/wiki>`_
|
||||
but it's being refactored heavily. There are known conversion issues
|
||||
and missing links. This will slowly be ironed out as this is developed.
|
||||
This is the **WIP** documentation of the development branch of Evennia (v1.0-dev).
|
||||
|
||||
New things will be added to this version only, but for now you are best
|
||||
off using v0.9.5 of the docs, or the original wiki. You have been warned.
|
||||
Unless you are beta-testing the new version, you are likely best
|
||||
off using v0.9.5 of the docs (switch to it in the bottom left)
|
||||
or the original github wiki. You have been warned.
|
||||
```
|
||||
|
||||
# Evennia Documentation
|
||||
|
|
@ -17,44 +14,60 @@ This is the manual of [Evennia](https://www.evennia.com), the open source Python
|
|||
`MU*` creation system.
|
||||
|
||||
- [Evennia Introduction](./Evennia-Introduction.md)
|
||||
- [Install & Setup Quickstart](Setup/Installation.md)
|
||||
- [Starting tutorial](Howto/Starting/Part1/Starting-Part1.md)
|
||||
- [Installation](Setup/Installation.md)
|
||||
- [Beginner Tutorial](Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md)
|
||||
- [How to contribute and get help](./Contributing.md)
|
||||
|
||||
## Main sections
|
||||
|
||||
- [Server Setup, Maintenance and Life](Setup/Setup-Overview.md) - how to run, maintain and release
|
||||
- [Tutorials and Howto's](Howto/Howto-Overview.md) - projects and hints for reaching particular effects and goals
|
||||
- [Tutorials and Howto's](Howtos/Howtos-Overview.md) - projects and hints for reaching particular effects and goals
|
||||
----
|
||||
|
||||
- [Core components](Components/Components-Overview.md) - the core building blocks of Evennia
|
||||
- [Concepts](Concepts/Concepts-Overview.md) - larger-scale concepts and features
|
||||
----
|
||||
|
||||
- [API](./Evennia-API.md) - the full API-reference, generated from source
|
||||
- [Default Commands](Components/Default-Commands.md) - list of game commands included out of the box
|
||||
- [Coding](Coding/Coding-Overview.md) - coding and development hints and resources
|
||||
- [Contributions](Contribs/Contrib-Overview.md) - game-specific tools and code added by the community
|
||||
- [Contribs](Contribs/Contribs-Overview.md) - game-specific tools and code added by the community
|
||||
----
|
||||
- [Links](./Links.md) - useful links
|
||||
- [Table of Contents](./toc.md) - an alphabetical listing of all regular documentation pages
|
||||
- [How to contribute to these docs](./Contributing-Docs.md) - if you want to help out
|
||||
|
||||
Want to help improve the docs? See the page on [Contributing to the docs](./Contributing-Docs.md)!
|
||||
## All Sections
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Click here to expand the full list of Documentation sections.
|
||||
</summary>
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 3
|
||||
|
||||
Evennia-Introduction
|
||||
Setup/Setup-Overview
|
||||
Howtos/Howtos-Overview
|
||||
Components/Components-Overview
|
||||
Concepts/Concepts-Overview
|
||||
Coding/Coding-Overview
|
||||
Contribs/Contribs-Overview
|
||||
Contributing
|
||||
Contributing-Docs
|
||||
Licensing
|
||||
Links
|
||||
|
||||
```
|
||||
</details>
|
||||
|
||||
|
||||
```{toctree}
|
||||
:hidden:
|
||||
|
||||
Evennia-Introduction
|
||||
Setup/Setup-Quickstart.md
|
||||
Howto/Starting/Part1/Starting-Part1.md
|
||||
Contributing.md
|
||||
Setup/Setup-Overview.md
|
||||
Howto/Howto-Overview.md
|
||||
Components/Components-Overview.md
|
||||
Concepts/Concepts-Overview.md
|
||||
Evennia-API.md
|
||||
Components/Default-Commands.md
|
||||
Coding/Coding-Overview.md
|
||||
Contribs/Contrib-Overview.md
|
||||
Links.md
|
||||
Glossary
|
||||
Evennia-API
|
||||
Licensing
|
||||
Unimplemented
|
||||
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue