From 03fcb81fb3c2b3fe9952f320b128119a345e78bb Mon Sep 17 00:00:00 2001 From: Griatch Date: Mon, 19 Oct 2020 22:40:43 +0200 Subject: [PATCH] Clean up develop doc build to avoid clashes --- .../Howto/Starting/Part1/Adding-Commands.md | 6 +-- .../Starting/Part1/Building-Quickstart.md | 4 -- .../Howto/Starting/Part1/Creating-Things.md | 4 -- .../Howto/Starting/Part1/Django-queries.md | 4 -- .../Part1/Evennia-Library-Overview.md | 3 -- .../Howto/Starting/Part1/Gamedir-Overview.md | 3 -- .../Starting/Part1/Learning-Typeclasses.md | 3 -- .../Howto/Starting/Part1/More-on-Commands.md | 3 -- .../Part1/Python-basic-introduction.md | 3 -- .../Part1/Python-classes-and-objects.md | 3 -- .../Howto/Starting/Part1/Searching-Things.md | 4 -- .../Howto/Starting/Part1/Starting-Part1.md | 52 ++++++++++++------- .../Part1/Tutorial-World-Introduction.md | 4 -- .../Howto/Starting/Part2/Game-Planning.md | 3 -- .../Part2/Planning-Some-Useful-Contribs.md | 3 -- .../Part2/Planning-The-Tutorial-Game.md | 4 -- .../Part2/Planning-Where-Do-I-Begin.md | 4 -- .../Howto/Starting/Part2/Starting-Part2.md | 13 ++++- .../Howto/Starting/Part3/Starting-Part3.md | 13 ++++- .../Howto/Starting/Part4/Starting-Part4.md | 4 +- .../Howto/Starting/Part5/Starting-Part5.md | 1 + docs/source/Unimplemented.md | 5 +- docs/source/index.md | 19 +++++++ 23 files changed, 82 insertions(+), 83 deletions(-) diff --git a/docs/source/Howto/Starting/Part1/Adding-Commands.md b/docs/source/Howto/Starting/Part1/Adding-Commands.md index 8478af37d1..95d1f06a40 100644 --- a/docs/source/Howto/Starting/Part1/Adding-Commands.md +++ b/docs/source/Howto/Starting/Part1/Adding-Commands.md @@ -1,7 +1,5 @@ # Our own commands -[prev lesson](./Searching-Things) | [next lesson](./More-on-Commands) - In this lesson we'll learn how to create our own Evennia _Commands_. If you are new to Python you'll also learn some more basics about how to manipulate strings and get information out of Evennia. @@ -391,6 +389,4 @@ In this lesson we learned how to create our own Command, add it to a CmdSet and We also upset a dragon. In the next lesson we'll learn how to hit Smaug with different weapons. We'll also -get into how we replace and extend Evennia's default Commands. - -[prev lesson](./Searching-Things) | [next lesson](./More-on-Commands) +get into how we replace and extend Evennia's default Commands. \ No newline at end of file diff --git a/docs/source/Howto/Starting/Part1/Building-Quickstart.md b/docs/source/Howto/Starting/Part1/Building-Quickstart.md index 27948f70d6..5c57c700dd 100644 --- a/docs/source/Howto/Starting/Part1/Building-Quickstart.md +++ b/docs/source/Howto/Starting/Part1/Building-Quickstart.md @@ -1,7 +1,5 @@ # Using the game and building stuff -[prev lesson](./Starting-Part1) | [next lesson](./Tutorial-World-Introduction) - In this lesson we will test out what we can do in-game out-of-the-box. Evennia ships with [around 90 default commands](api:evennia.commands.default#modules), and while you can override those as you please, they can be quite useful. @@ -312,5 +310,3 @@ You will now find your new `History` entry in the `help` list and read your help After this brief introduction to building and using in-game commands you may be ready to see a more fleshed-out example. Evennia comes with a tutorial world for you to explore. We will try that out in the next section. - -[prev lesson](./Starting-Part1) | [next lesson](./Tutorial-World-Introduction) diff --git a/docs/source/Howto/Starting/Part1/Creating-Things.md b/docs/source/Howto/Starting/Part1/Creating-Things.md index 3faf93e6f7..163d54049f 100644 --- a/docs/source/Howto/Starting/Part1/Creating-Things.md +++ b/docs/source/Howto/Starting/Part1/Creating-Things.md @@ -1,6 +1,5 @@ # Creating things -[prev lesson](./Learning-Typeclasses) | [next lesson](./Searching-Things) We have already created some things - dragons for example. There are many different things to create in Evennia though. In the last lesson we learned about typeclasses, the way to make objects persistent in the database. @@ -48,6 +47,3 @@ You can find the parent class for Accounts in `typeclasses/accounts.py`. _TODO_ - -[prev lesson](./Learning-Typeclasses) | [next lesson](./Searching-Things) - diff --git a/docs/source/Howto/Starting/Part1/Django-queries.md b/docs/source/Howto/Starting/Part1/Django-queries.md index 29ce7cafe1..e5003df9c7 100644 --- a/docs/source/Howto/Starting/Part1/Django-queries.md +++ b/docs/source/Howto/Starting/Part1/Django-queries.md @@ -1,7 +1,5 @@ # Django Database queries -[prev lesson](./Searching-Things) | [next lesson](../Part2/Starting-Part2) - ```important:: More advanced lesson! Learning about Django's queryset language is very useful once you start doing more advanced things @@ -397,5 +395,3 @@ query using Django is a powerful skill to have. This concludes the first part of the Evennia starting tutorial - "What we have". Now we have a good foundation to understand how to plan what our tutorial game will be about. - -[prev lesson](./Searching-Things) | [next lesson](../Part2/Starting-Part2) diff --git a/docs/source/Howto/Starting/Part1/Evennia-Library-Overview.md b/docs/source/Howto/Starting/Part1/Evennia-Library-Overview.md index 8a4aa82cde..2759df207b 100644 --- a/docs/source/Howto/Starting/Part1/Evennia-Library-Overview.md +++ b/docs/source/Howto/Starting/Part1/Evennia-Library-Overview.md @@ -1,7 +1,5 @@ # Overview of the Evennia library -[prev lesson](./Python-classes-and-objects) | [next lesson](./Learning-Typeclasses) - ```sidebar:: API API stands for `Application Programming Interface`, a description for how to access @@ -125,5 +123,4 @@ to look it up in the docs: 5. You can now read what this does and what methods are on it. If you want to see the full source, click the \[[source](src:evennia.objects.objects#DefaultObject)\] link. -[prev lesson](./Python-classes-and-objects) | [next lesson](./Learning-Typeclasses) diff --git a/docs/source/Howto/Starting/Part1/Gamedir-Overview.md b/docs/source/Howto/Starting/Part1/Gamedir-Overview.md index 3ed0e5ef7b..23416dd756 100644 --- a/docs/source/Howto/Starting/Part1/Gamedir-Overview.md +++ b/docs/source/Howto/Starting/Part1/Gamedir-Overview.md @@ -1,7 +1,5 @@ # Overview of your new Game Dir -[prev lesson](./Python-basic-introduction) | [next lesson](./Python-classes-and-objects) - Next we will take a little detour to look at the _Tutorial World_. This is a little solo adventure that comes with Evennia, a showcase for some of the things that are possible. @@ -208,4 +206,3 @@ people change and re-structure this in various ways to better fit their ideas. tell that Two goblins, while both of the class 'Goblin' (so they follow the same code logic), should have different equipment, stats and looks. -[prev lesson](./Python-basic-introduction) | [next lesson](./Python-classes-and-objects) diff --git a/docs/source/Howto/Starting/Part1/Learning-Typeclasses.md b/docs/source/Howto/Starting/Part1/Learning-Typeclasses.md index 7ad45a4c6b..a483f50f98 100644 --- a/docs/source/Howto/Starting/Part1/Learning-Typeclasses.md +++ b/docs/source/Howto/Starting/Part1/Learning-Typeclasses.md @@ -1,7 +1,5 @@ # Persistent objects and typeclasses -[prev lesson](./Evennia-Library-Overview) | [next lesson](./Creating-Things) - Now that we have learned a little about how to find things in the Evennia library, let's use it. In the [Python classes and objects](./Python-classes-and-objects) lesson we created the dragons Fluffy, Cuddly @@ -621,4 +619,3 @@ Typeclasses are a fundamental part of Evennia and we will see a lot of more uses this tutorial. But that's enough of them for now. It's time to take some action. Let's learn about _Commands_. -[prev lesson](./Evennia-Library-Overview) | [next lesson](./Creating-Things) diff --git a/docs/source/Howto/Starting/Part1/More-on-Commands.md b/docs/source/Howto/Starting/Part1/More-on-Commands.md index 6828cc1b76..13fa5f05c5 100644 --- a/docs/source/Howto/Starting/Part1/More-on-Commands.md +++ b/docs/source/Howto/Starting/Part1/More-on-Commands.md @@ -1,7 +1,5 @@ # More about Commands -[prev lesson](./Adding-Commands) | [next lesson](./Creating-Things) - In this lesson we learn some basics about parsing the input of Commands. We will also learn how to add, modify and extend Evennia's default commands. @@ -497,4 +495,3 @@ In this lesson we got into some more advanced string formatting - many of those the future! We also made a functional sword. Finally we got into how to add to, extend and replace a default command on ourselves. -[prev lesson](./Adding-Commands) | [next lesson](./Creating-Things) diff --git a/docs/source/Howto/Starting/Part1/Python-basic-introduction.md b/docs/source/Howto/Starting/Part1/Python-basic-introduction.md index 440e3e80c7..a5f3332ac5 100644 --- a/docs/source/Howto/Starting/Part1/Python-basic-introduction.md +++ b/docs/source/Howto/Starting/Part1/Python-basic-introduction.md @@ -1,7 +1,5 @@ # Starting to code Evennia -[prev lesson](./Tutorial-World-Introduction) | [next lesson](./Gamedir-Overview) - Time to dip our toe into some coding! Evennia is written and extended in [Python](http://python.org), which is a mature and professional programming language that is very fast to work with. @@ -651,4 +649,3 @@ practice you will be writing most your code in Python modules. To that end we also created a first new Python module in the `mygame/` game dir, then imported and used it. Now let's look at the rest of the stuff you've got going on inside that `mygame/` folder ... -[prev lesson](./Tutorial-World-Introduction) | [next lesson](./Gamedir-Overview) diff --git a/docs/source/Howto/Starting/Part1/Python-classes-and-objects.md b/docs/source/Howto/Starting/Part1/Python-classes-and-objects.md index 4ca57cd5ab..5388d11169 100644 --- a/docs/source/Howto/Starting/Part1/Python-classes-and-objects.md +++ b/docs/source/Howto/Starting/Part1/Python-classes-and-objects.md @@ -1,7 +1,5 @@ # Python Classes and objects -[prev lesson](./Gamedir-Overview) | [next lesson](./Evennia-Library-Overview) - We have now learned how to run some simple Python code from inside (and outside) your game server. We have also taken a look at what our game dir looks and what is where. Now we'll start to use it. @@ -412,4 +410,3 @@ with one in the child class. We also used `super()` to good effect. We have used pretty much raw Python so far. In the coming lessons we'll start to look at the extra bits that Evennia provides. But first we need to learn just where to find everything. -[prev lesson](./Gamedir-Overview) | [next lesson](./Evennia-Library-Overview) diff --git a/docs/source/Howto/Starting/Part1/Searching-Things.md b/docs/source/Howto/Starting/Part1/Searching-Things.md index d92d95ece0..d0b13edded 100644 --- a/docs/source/Howto/Starting/Part1/Searching-Things.md +++ b/docs/source/Howto/Starting/Part1/Searching-Things.md @@ -1,7 +1,5 @@ # Searching for things -[prev lesson](./Creating-Things) | [next lesson](./Django-queries) - We have gone through how to create the various entities in Evennia. But creating something is of little use if we cannot find and use it afterwards. @@ -261,5 +259,3 @@ these tools will be all you need ... ... but not always. In the next lesson we will dive further into more complex searching when we look at Django queries and querysets in earnest. -[prev lesson](./Creating-Things) | [next lesson](./Django-queries) - diff --git a/docs/source/Howto/Starting/Part1/Starting-Part1.md b/docs/source/Howto/Starting/Part1/Starting-Part1.md index 8c57b8c625..a4787f538c 100644 --- a/docs/source/Howto/Starting/Part1/Starting-Part1.md +++ b/docs/source/Howto/Starting/Part1/Starting-Part1.md @@ -1,7 +1,5 @@ # Starting Tutorial (Part 1) -[Start](./Building-Quickstart) - ```sidebar:: Tutorial Parts **Part 1: What we have** @@ -23,23 +21,19 @@ and share with others! ## Lessons of Part 1 - "What we have" -```toctree:: - :numbered: - :maxdepth: 1 - - Building stuff - The Tutorial World - Python basics - Game dir overview - Python classes and objects - Accessing the Evennia library - Typeclasses and Persistent objects - Making first own Commands - Parsing and replacing default Commands - Creating things - Searching for things - Advanced searching with Django queries -``` +1. Introduction (you are here) +1. [Building stuff](./Building-Quickstart) +1. [The Tutorial World](./Tutorial-World-Introduction) +1. [Python basics](./Python-basic-introduction) +1. [Game dir overview](./Gamedir-Overview) +1. [Python classes and objects](./Python-classes-and-objects) +1. [Accessing the Evennia library](./Evennia-Library-Overview) +1. [Typeclasses and Persistent objects](./Learning-Typeclasses) +1. [Making first own Commands](./Adding-Commands) +1. [Parsing and replacing default Commands](./More-on-Commands) +1. [Creating things](./Creating-Things) +1. [Searching for things](./Searching-Things) +1. [Advanced searching with Django queries](./Django-queries) In this first part we'll focus on what we get out of the box in Evennia - we'll get used to the tools, and how to find things we are looking for. We will also dive into some of things you'll @@ -114,4 +108,22 @@ first enter that gamedir and run You should now be good to go! - [Start](./Building-Quickstart) \ No newline at end of file + + ```toctree:: + :hidden: + + Building-Quickstart + Tutorial-World-Introduction + Python-basic-introduction + Gamedir-Overview + Python-classes-and-objects + Evennia-Library-Overview + Learning-Typeclasses + Adding-Commands + More-on-Commands + Creating-Things + Searching-Things + Django-queries + ../Part2/Starting-Part2 + +``` \ No newline at end of file diff --git a/docs/source/Howto/Starting/Part1/Tutorial-World-Introduction.md b/docs/source/Howto/Starting/Part1/Tutorial-World-Introduction.md index 3c31a3b0a6..34c8ce2df6 100644 --- a/docs/source/Howto/Starting/Part1/Tutorial-World-Introduction.md +++ b/docs/source/Howto/Starting/Part1/Tutorial-World-Introduction.md @@ -1,7 +1,5 @@ # The Tutorial World -[prev lesson](./Building-Quickstart) | [next lesson](./Python-basic-introduction) - The *Tutorial World* is a small and functioning MUD-style game world shipped with Evennia. It's a small showcase of what is possible. It can also be useful for those who have an easier time learning by deconstructing existing code. @@ -115,5 +113,3 @@ should hopefully have given you a little taste of some of the possibilities of move on with how to access this power through code. -[prev lesson](./Building-Quickstart) | [next lesson](./Python-basic-introduction) - diff --git a/docs/source/Howto/Starting/Part2/Game-Planning.md b/docs/source/Howto/Starting/Part2/Game-Planning.md index 19abd03e09..5a052f44d2 100644 --- a/docs/source/Howto/Starting/Part2/Game-Planning.md +++ b/docs/source/Howto/Starting/Part2/Game-Planning.md @@ -1,5 +1,3 @@ -[prev lesson](./Planning-Where-Do-I-Begin) | [next lesson](./Planning-The-Tutorial-Game) - # On Planning a Game Last lesson we asked ourselves some questions about our motivation. In this one we'll present @@ -209,4 +207,3 @@ have made their dream game a reality! In the next lesson we'll make use of these general points and try to plan out our tutorial game. -[prev lesson](./Planning-Where-Do-I-Begin) | [next lesson](./Planning-The-Tutorial-Game) diff --git a/docs/source/Howto/Starting/Part2/Planning-Some-Useful-Contribs.md b/docs/source/Howto/Starting/Part2/Planning-Some-Useful-Contribs.md index 84bf19b695..907e221c0a 100644 --- a/docs/source/Howto/Starting/Part2/Planning-Some-Useful-Contribs.md +++ b/docs/source/Howto/Starting/Part2/Planning-Some-Useful-Contribs.md @@ -1,5 +1,3 @@ -[prev lesson](./Planning-The-Tutorial-Game) | [next lesson](../Part3/Starting-Part3) - # Planning the use of some useful contribs Evennia is deliberately bare-bones out of the box. The idea is that you should be as unrestricted as possible @@ -252,4 +250,3 @@ in the next part of this tutorial series. When doing this for yourself, remember back to your planning and adjust it as you learn what works and what does not. -[prev lesson](./Planning-The-Tutorial-Game) | [next lesson](../Part3/Starting-Part3) diff --git a/docs/source/Howto/Starting/Part2/Planning-The-Tutorial-Game.md b/docs/source/Howto/Starting/Part2/Planning-The-Tutorial-Game.md index 1d434ea636..03c598cf05 100644 --- a/docs/source/Howto/Starting/Part2/Planning-The-Tutorial-Game.md +++ b/docs/source/Howto/Starting/Part2/Planning-The-Tutorial-Game.md @@ -1,5 +1,3 @@ -[prev lesson](./Game-Planning) | [next lesson](./Planning-Some-Useful-Contribs) - # Planning our tutorial game Using the general plan from last lesson we'll now establish what kind of game we want to create for this tutorial. @@ -425,5 +423,3 @@ playable game! Before starting to code in earnest a good coder should always do an inventory of all the stuff they _don't_ need to code themselves. So in the next lesson we will check out what help we have from Evennia's _contribs_. - -[prev lesson](./Game-Planning) | [next lesson](./Planning-Some-Useful-Contribs) \ No newline at end of file diff --git a/docs/source/Howto/Starting/Part2/Planning-Where-Do-I-Begin.md b/docs/source/Howto/Starting/Part2/Planning-Where-Do-I-Begin.md index 6d8792b18e..c5af620bc5 100644 --- a/docs/source/Howto/Starting/Part2/Planning-Where-Do-I-Begin.md +++ b/docs/source/Howto/Starting/Part2/Planning-Where-Do-I-Begin.md @@ -1,5 +1,3 @@ -[prev lesson](./Starting-Part2) | [next lesson](./Game-Planning) - # Where do I begin? The good news is that following this Starting tutorial is a great way to begin making an Evennia game. @@ -145,5 +143,3 @@ works best for you. In the next lesson we'll go through some of the technical questions you need to consider. This should hopefully help you figure out more about the game you want to make. In the lesson following that we'll then try to answer those questions for the sake of creating our little tutorial game. - -[prev lesson](./Starting-Part2) | [next lesson](./Game-Planning) \ No newline at end of file diff --git a/docs/source/Howto/Starting/Part2/Starting-Part2.md b/docs/source/Howto/Starting/Part2/Starting-Part2.md index 9040bdefe7..c56988054f 100644 --- a/docs/source/Howto/Starting/Part2/Starting-Part2.md +++ b/docs/source/Howto/Starting/Part2/Starting-Part2.md @@ -26,4 +26,15 @@ programming. 1. [Planning to use some useful Contribs](./Planning-Some-Useful-Contribs) In the process we'll go through the common questions of "where to start" -and "what to think about" when creating a multiplayer online text game. \ No newline at end of file +and "what to think about" when creating a multiplayer online text game. + + +```toctree:: + :hidden: + + Planning-Where-Do-I-Begin + Game-Planning + Planning-Some-Useful-Contribs + ../Part3/Starting-Part3 + +``` diff --git a/docs/source/Howto/Starting/Part3/Starting-Part3.md b/docs/source/Howto/Starting/Part3/Starting-Part3.md index 59bb23fb70..cda32b590d 100644 --- a/docs/source/Howto/Starting/Part3/Starting-Part3.md +++ b/docs/source/Howto/Starting/Part3/Starting-Part3.md @@ -17,6 +17,7 @@ In part three of the Evennia Starting tutorial we will go through the creation o of our tutorial game _EvAdventure_. As we go, we will test each part and create a simple "tech demo" to show off all the moving parts. +1. Introduction & Overview (you are here) 1. [Changing settings](../../../Unimplemented) 1. [Applying contribs](../../../Unimplemented) 1. [Creating a rule module](../../../Unimplemented) @@ -31,4 +32,14 @@ show off all the moving parts. If you followed the previous parts of this tutorial you will have some notions about Python and where to find and make use of things in Evennia. We also have a good idea of the type of game we want. Even if this is not the game-style you are interested in, following along will give you a lot of experience -with using Evennia. This be of much use when doing your own thing later. \ No newline at end of file +with using Evennia. This be of much use when doing your own thing later. + +_TODO_ + + +```toctree:: + :hidden: + + ../../../Unimplemented + +``` \ No newline at end of file diff --git a/docs/source/Howto/Starting/Part4/Starting-Part4.md b/docs/source/Howto/Starting/Part4/Starting-Part4.md index 78dcb93f85..00e0856e3a 100644 --- a/docs/source/Howto/Starting/Part4/Starting-Part4.md +++ b/docs/source/Howto/Starting/Part4/Starting-Part4.md @@ -18,4 +18,6 @@ We now have the code underpinnings of everything we need. We have also tested th and has a simple tech-demo to show it all works together. But there is no real coherence to it at this point - we need to actually make a world. In part four we will expand our tech demo into a more full-fledged (if small) game by use of batchcommand -and batchcode processors. \ No newline at end of file +and batchcode processors. + +_TODO_ \ No newline at end of file diff --git a/docs/source/Howto/Starting/Part5/Starting-Part5.md b/docs/source/Howto/Starting/Part5/Starting-Part5.md index 9040df0948..704f2760dc 100644 --- a/docs/source/Howto/Starting/Part5/Starting-Part5.md +++ b/docs/source/Howto/Starting/Part5/Starting-Part5.md @@ -18,3 +18,4 @@ You have a working game! In part five we will look at the web-components of Even to fit your game. We will also look at hosting your game and if you feel up to it we'll also go through how to bring your game online so you can invite your first players. +_TODO_ \ No newline at end of file diff --git a/docs/source/Unimplemented.md b/docs/source/Unimplemented.md index cf2f03862c..99be5ebf38 100644 --- a/docs/source/Unimplemented.md +++ b/docs/source/Unimplemented.md @@ -1,6 +1,5 @@ # Unimplemented -```warning:: This page has not been written yet. -``` +_Sorry, but this page has not been written yet._ -Return to the [front page](./index#Evennia-documentation). \ No newline at end of file +Go back or return to the [front page](./index#Evennia-documentation). \ No newline at end of file diff --git a/docs/source/index.md b/docs/source/index.md index c56a3d56e3..2a22d053bd 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -37,3 +37,22 @@ This is the manual of [Evennia](http://www.evennia.com), the open source Python - [Table of Contents](./toc) - an alphabetical listing of all regular documentation pages Want to help improve the docs? See the page on [Contributing to the docs](./Contributing-Docs)! + + +```toctree:: + :hidden: + + Evennia-Introduction + Setup/Setup-Quickstart + Howto/Starting/Part1/Starting-Part1 + How-To-Get-And-Give-Help + Setup/Setup-Overview + Howto/Howto-Overview + Components/Components-Overview + Concepts/Concepts-Overview + Evennia-API + Coding/Coding-Overview + Contribs/Contrib-Overview + Links + +``` \ No newline at end of file