diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 3309593025..c404821897 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -7,7 +7,7 @@ Welcome to Evennia's documentation! =================================== `Evennia `_ is a barebones Python -MUD/MUX/MU\* server/codebase using modern technologies and offering +MUD/MUX/MU\* creation system and server. It is using modern technologies and offering great freedom to design the multi-user online text game of your dreams. You code your game using normal Python modules - can't get more flexible than that! @@ -18,13 +18,12 @@ intervals. .. toctree:: :titlesonly: + :maxdepth: 1 - Continue to the Manual - -.. toctree:: - + Enter Manual How to give and get help - Resources + Links + Alphabetical Page index .. Code .. ----- @@ -34,71 +33,3 @@ intervals. .. Browse Code -.. toctree:: - :hidden: - - wiki/Index - wiki/EvenniaIntroduction - wiki/SoftCode - wiki/GettingStarted - wiki/AdminDocs - wiki/ChoosingAnSQLServer - wiki/StartStopReload - wiki/UpdatingYourGame - wiki/Internationalization - wiki/ApacheConfig - wiki/TextEncodings - wiki/IRC - wiki/IMC2 - wiki/BuilderDocs - wiki/DefaultCommandHelp - wiki/BuildingQuickstart - wiki/BuildingPermissions - wiki/Colours - wiki/ConnectionScreen - wiki/BatchProcessors - wiki/BatchCommandProcessor - wiki/BatchCodeProcessor - wiki/TutorialWorldIntroduction - wiki/DeveloperCentral - wiki/Licensing - wiki/Contributing - wiki/UsingMUXAsAStandard - wiki/DirectoryOverview - wiki/PortalAndServer - wiki/Commands - wiki/Typeclasses - wiki/Objects - wiki/Scripts - wiki/Players - wiki/Attributes - wiki/Locks - wiki/Communications - wiki/HelpSystem - wiki/Nicks - wiki/SessionProtocols - wiki/WebFeatures - wiki/ExecutePythonCode - wiki/UnitTesting - wiki/RemovingColour - wiki/CommandPrompt - wiki/AsyncProcess - wiki/WorkshopDefaultGame - wiki/Workshop - wiki/EvenniaDevel - wiki/Banning - wiki/CodingIntroduction - wiki/CodingUtils - wiki/CommandCooldown - wiki/GamePlanning - wiki/GettingHelp - wiki/OnlineSetup - wiki/Quirks - wiki/RSS - wiki/ServerConf - wiki/TickerScripts - wiki/Tutorials - wiki/VersionControl - wiki/Zones - wiki/evAPI - wiki/AddingCommandTutorial diff --git a/docs/sphinx/source/wiki/AsyncProcess.rst b/docs/sphinx/source/wiki/AsyncProcess.rst index 8c5fc859ce..9d50e22b74 100644 --- a/docs/sphinx/source/wiki/AsyncProcess.rst +++ b/docs/sphinx/source/wiki/AsyncProcess.rst @@ -1,5 +1,3 @@ -Running code asynchronously - Asynchronous code ================= diff --git a/docs/sphinx/source/wiki/Attributes.rst b/docs/sphinx/source/wiki/Attributes.rst index 3f3646a1f9..19e852687d 100644 --- a/docs/sphinx/source/wiki/Attributes.rst +++ b/docs/sphinx/source/wiki/Attributes.rst @@ -1,5 +1,3 @@ -Using attributes to store data - Attributes ========== diff --git a/docs/sphinx/source/wiki/BatchCodeProcessor.rst b/docs/sphinx/source/wiki/BatchCodeProcessor.rst index 55f9f6d3fb..745f0598df 100644 --- a/docs/sphinx/source/wiki/BatchCodeProcessor.rst +++ b/docs/sphinx/source/wiki/BatchCodeProcessor.rst @@ -1,5 +1,3 @@ -Using the Evennia batch code processor - The Batch-Code processor ======================== diff --git a/docs/sphinx/source/wiki/BatchCommandProcessor.rst b/docs/sphinx/source/wiki/BatchCommandProcessor.rst index 5b532097b7..2835c96850 100644 --- a/docs/sphinx/source/wiki/BatchCommandProcessor.rst +++ b/docs/sphinx/source/wiki/BatchCommandProcessor.rst @@ -1,5 +1,3 @@ -Using the Evennia command batch processors - The Batch-Command processor =========================== diff --git a/docs/sphinx/source/wiki/BatchProcessors.rst b/docs/sphinx/source/wiki/BatchProcessors.rst index cb41a9e5e4..2698b56e4b 100644 --- a/docs/sphinx/source/wiki/BatchProcessors.rst +++ b/docs/sphinx/source/wiki/BatchProcessors.rst @@ -1,5 +1,3 @@ -Introduction to batch processors - Batch Processors - overview =========================== diff --git a/docs/sphinx/source/wiki/BuildingPermissions.rst b/docs/sphinx/source/wiki/BuildingPermissions.rst index 0b1c8565eb..d0bd62c9af 100644 --- a/docs/sphinx/source/wiki/BuildingPermissions.rst +++ b/docs/sphinx/source/wiki/BuildingPermissions.rst @@ -1,5 +1,3 @@ -Introduction to setting permissions - Giving permissions to your staff ================================ diff --git a/docs/sphinx/source/wiki/BuildingQuickstart.rst b/docs/sphinx/source/wiki/BuildingQuickstart.rst index 94a1fa7539..2fcd2c7e96 100644 --- a/docs/sphinx/source/wiki/BuildingQuickstart.rst +++ b/docs/sphinx/source/wiki/BuildingQuickstart.rst @@ -1,5 +1,3 @@ -A quick-start guide to in-game building in Evennia. - Building Quick-start ==================== diff --git a/docs/sphinx/source/wiki/Colours.rst b/docs/sphinx/source/wiki/Colours.rst index a27d1fcd5b..fd031a8c64 100644 --- a/docs/sphinx/source/wiki/Colours.rst +++ b/docs/sphinx/source/wiki/Colours.rst @@ -1,5 +1,3 @@ -Adding colour - Adding Colour to your game ========================== diff --git a/docs/sphinx/source/wiki/CommandPrompt.rst b/docs/sphinx/source/wiki/CommandPrompt.rst index c968022e45..2676ff39b8 100644 --- a/docs/sphinx/source/wiki/CommandPrompt.rst +++ b/docs/sphinx/source/wiki/CommandPrompt.rst @@ -1,5 +1,3 @@ -Adding a command prompt to your game - Adding a command prompt ======================= diff --git a/docs/sphinx/source/wiki/Commands.rst b/docs/sphinx/source/wiki/Commands.rst index 64c8c7cb45..9adae4e518 100644 --- a/docs/sphinx/source/wiki/Commands.rst +++ b/docs/sphinx/source/wiki/Commands.rst @@ -1,5 +1,3 @@ -Details on how to use and extend the command system. - Command system ============== diff --git a/docs/sphinx/source/wiki/Communications.rst b/docs/sphinx/source/wiki/Communications.rst index 974ce04281..43cce3cf52 100644 --- a/docs/sphinx/source/wiki/Communications.rst +++ b/docs/sphinx/source/wiki/Communications.rst @@ -1,5 +1,3 @@ -Handling of ooc communications in game - Communications ============== diff --git a/docs/sphinx/source/wiki/ConnectionScreen.rst b/docs/sphinx/source/wiki/ConnectionScreen.rst index 5d46bceebb..433f57d5dd 100644 --- a/docs/sphinx/source/wiki/ConnectionScreen.rst +++ b/docs/sphinx/source/wiki/ConnectionScreen.rst @@ -1,5 +1,3 @@ -Customizing the connection screen - The Connection Screen ===================== diff --git a/docs/sphinx/source/wiki/Contributing.rst b/docs/sphinx/source/wiki/Contributing.rst index 8b80555996..2bfff0cd41 100644 --- a/docs/sphinx/source/wiki/Contributing.rst +++ b/docs/sphinx/source/wiki/Contributing.rst @@ -1,5 +1,3 @@ -Contributing - Contributing to Evennia ======================= diff --git a/docs/sphinx/source/wiki/DefaultCommandHelp.rst b/docs/sphinx/source/wiki/DefaultCommandHelp.rst index afe84794f6..1b4679c7b6 100644 --- a/docs/sphinx/source/wiki/DefaultCommandHelp.rst +++ b/docs/sphinx/source/wiki/DefaultCommandHelp.rst @@ -1,5 +1,3 @@ -Auto-generated list of default Evennia commands - Commands in Evennia's default command set ========================================= diff --git a/docs/sphinx/source/wiki/DirectoryOverview.rst b/docs/sphinx/source/wiki/DirectoryOverview.rst index 5d7b6d699a..6764fb8726 100644 --- a/docs/sphinx/source/wiki/DirectoryOverview.rst +++ b/docs/sphinx/source/wiki/DirectoryOverview.rst @@ -1,5 +1,3 @@ -The layout of the evennia package - Evennia directory overview ========================== diff --git a/docs/sphinx/source/wiki/EvenniaDevel.rst b/docs/sphinx/source/wiki/EvenniaDevel.rst index 5f35e7a363..8278cc2bc0 100644 --- a/docs/sphinx/source/wiki/EvenniaDevel.rst +++ b/docs/sphinx/source/wiki/EvenniaDevel.rst @@ -1,5 +1,3 @@ -Summary of changes in devel-branch - *Note: The devel branch merged with trunk as of r970 (aug2010). So if you are new to Evennia, this page is of no real interest to you.* diff --git a/docs/sphinx/source/wiki/EvenniaIntroduction.rst b/docs/sphinx/source/wiki/EvenniaIntroduction.rst index 43e3a732ea..e3275e4e5b 100644 --- a/docs/sphinx/source/wiki/EvenniaIntroduction.rst +++ b/docs/sphinx/source/wiki/EvenniaIntroduction.rst @@ -1,5 +1,3 @@ -Introduction - "*A MUD (originally Multi-User Dungeon, with later variants Multi-User Dimension and Multi-User Domain), pronounced 'mud', is a multiplayer real-time virtual world described primarily in text. diff --git a/docs/sphinx/source/wiki/ExecutePythonCode.rst b/docs/sphinx/source/wiki/ExecutePythonCode.rst index f79ec7d69d..00842b1b60 100644 --- a/docs/sphinx/source/wiki/ExecutePythonCode.rst +++ b/docs/sphinx/source/wiki/ExecutePythonCode.rst @@ -1,5 +1,3 @@ -Running python code parsers for testing and debugging - The \`@py\` command =================== diff --git a/docs/sphinx/source/wiki/HelpSystem.rst b/docs/sphinx/source/wiki/HelpSystem.rst index 1e0519b438..6ea683b9c8 100644 --- a/docs/sphinx/source/wiki/HelpSystem.rst +++ b/docs/sphinx/source/wiki/HelpSystem.rst @@ -1,5 +1,3 @@ -Evennia's help system - Help system =========== diff --git a/docs/sphinx/source/wiki/HowToGetAndGiveHelp.rst b/docs/sphinx/source/wiki/HowToGetAndGiveHelp.rst index 87fc2e8f65..73c9f937b0 100644 --- a/docs/sphinx/source/wiki/HowToGetAndGiveHelp.rst +++ b/docs/sphinx/source/wiki/HowToGetAndGiveHelp.rst @@ -1,5 +1,3 @@ -Getting and giving Evennia-help - How to \_get\_ Help =================== diff --git a/docs/sphinx/source/wiki/IMC2.rst b/docs/sphinx/source/wiki/IMC2.rst index baf648b2a5..c87cd0fd38 100644 --- a/docs/sphinx/source/wiki/IMC2.rst +++ b/docs/sphinx/source/wiki/IMC2.rst @@ -1,5 +1,3 @@ -Introduction to and configuration for IMC2. - IMC2 ==== diff --git a/docs/sphinx/source/wiki/IRC.rst b/docs/sphinx/source/wiki/IRC.rst index 7dc773a5a3..2830a583b2 100644 --- a/docs/sphinx/source/wiki/IRC.rst +++ b/docs/sphinx/source/wiki/IRC.rst @@ -1,5 +1,3 @@ -Configuring IRC connectivity - IRC === diff --git a/docs/sphinx/source/wiki/Internationalization.rst b/docs/sphinx/source/wiki/Internationalization.rst index 3e1eab5837..6c01bc8d9e 100644 --- a/docs/sphinx/source/wiki/Internationalization.rst +++ b/docs/sphinx/source/wiki/Internationalization.rst @@ -1,5 +1,3 @@ -changing and creating new translations - Internationalization ==================== diff --git a/docs/sphinx/source/wiki/Licensing.rst b/docs/sphinx/source/wiki/Licensing.rst index 23701f63af..cab80cd016 100644 --- a/docs/sphinx/source/wiki/Licensing.rst +++ b/docs/sphinx/source/wiki/Licensing.rst @@ -1,5 +1,3 @@ -The Licensing of Evennia - Evennia Licence FAQ =================== diff --git a/docs/sphinx/source/wiki/Links.rst b/docs/sphinx/source/wiki/Links.rst index ae2464503e..31ece77df4 100644 --- a/docs/sphinx/source/wiki/Links.rst +++ b/docs/sphinx/source/wiki/Links.rst @@ -1,5 +1,3 @@ -External links - External links and resources ============================ diff --git a/docs/sphinx/source/wiki/Locks.rst b/docs/sphinx/source/wiki/Locks.rst index 208bd27534..601b351817 100644 --- a/docs/sphinx/source/wiki/Locks.rst +++ b/docs/sphinx/source/wiki/Locks.rst @@ -1,5 +1,3 @@ -Locks and Permissions - Locks ===== diff --git a/docs/sphinx/source/wiki/Nicks.rst b/docs/sphinx/source/wiki/Nicks.rst index 46e14c6f80..37731ca1eb 100644 --- a/docs/sphinx/source/wiki/Nicks.rst +++ b/docs/sphinx/source/wiki/Nicks.rst @@ -1,5 +1,3 @@ -Using nicknames - Nicks ===== diff --git a/docs/sphinx/source/wiki/Objects.rst b/docs/sphinx/source/wiki/Objects.rst index 3a9e993fb3..b39616d210 100644 --- a/docs/sphinx/source/wiki/Objects.rst +++ b/docs/sphinx/source/wiki/Objects.rst @@ -1,5 +1,3 @@ -Object typeclass - Objects ======= diff --git a/docs/sphinx/source/wiki/Players.rst b/docs/sphinx/source/wiki/Players.rst index ebbf72e3b1..5128d97ac8 100644 --- a/docs/sphinx/source/wiki/Players.rst +++ b/docs/sphinx/source/wiki/Players.rst @@ -1,5 +1,3 @@ -Player typeclass - Players ======= diff --git a/docs/sphinx/source/wiki/PortalAndServer.rst b/docs/sphinx/source/wiki/PortalAndServer.rst index d7c29f9ce9..39c44f781e 100644 --- a/docs/sphinx/source/wiki/PortalAndServer.rst +++ b/docs/sphinx/source/wiki/PortalAndServer.rst @@ -1,5 +1,3 @@ -Portal and Server - Portal and Server layout ======================== diff --git a/docs/sphinx/source/wiki/RemovingColour.rst b/docs/sphinx/source/wiki/RemovingColour.rst index 7d49a55217..2de4e4b212 100644 --- a/docs/sphinx/source/wiki/RemovingColour.rst +++ b/docs/sphinx/source/wiki/RemovingColour.rst @@ -1,5 +1,3 @@ -Tutorial for adding configuration - Tutorial: Removing colour from your game ======================================== diff --git a/docs/sphinx/source/wiki/Scripts.rst b/docs/sphinx/source/wiki/Scripts.rst index 9e51f372f1..46c3b65777 100644 --- a/docs/sphinx/source/wiki/Scripts.rst +++ b/docs/sphinx/source/wiki/Scripts.rst @@ -1,5 +1,3 @@ -Script typeclass - Scripts ======= diff --git a/docs/sphinx/source/wiki/SessionProtocols.rst b/docs/sphinx/source/wiki/SessionProtocols.rst index 43104ecc91..1c689683fb 100644 --- a/docs/sphinx/source/wiki/SessionProtocols.rst +++ b/docs/sphinx/source/wiki/SessionProtocols.rst @@ -1,5 +1,3 @@ -Describing the Portal Session and Protocol system - Portal Sessions and Protocols ============================= diff --git a/docs/sphinx/source/wiki/SoftCode.rst b/docs/sphinx/source/wiki/SoftCode.rst index 2c26bb57b9..59905ba29f 100644 --- a/docs/sphinx/source/wiki/SoftCode.rst +++ b/docs/sphinx/source/wiki/SoftCode.rst @@ -1,6 +1,3 @@ -A brief explanation of what MUSH softcode is and why we use Python -instead. - On MUX and Softcode: A brief overview ===================================== diff --git a/docs/sphinx/source/wiki/StartStopReload.rst b/docs/sphinx/source/wiki/StartStopReload.rst index c8f349e88c..96f1a1a771 100644 --- a/docs/sphinx/source/wiki/StartStopReload.rst +++ b/docs/sphinx/source/wiki/StartStopReload.rst @@ -1,5 +1,3 @@ -Controlling Evennia processes - Running Evennia =============== diff --git a/docs/sphinx/source/wiki/TextEncodings.rst b/docs/sphinx/source/wiki/TextEncodings.rst index a2ccd87cfd..fc2dfc2b35 100644 --- a/docs/sphinx/source/wiki/TextEncodings.rst +++ b/docs/sphinx/source/wiki/TextEncodings.rst @@ -1,5 +1,3 @@ -Text encodings - Notes on text encodings ======================= diff --git a/docs/sphinx/source/wiki/TutorialWorldIntroduction.rst b/docs/sphinx/source/wiki/TutorialWorldIntroduction.rst index 3d0bb0c4c8..c51acfd7a9 100644 --- a/docs/sphinx/source/wiki/TutorialWorldIntroduction.rst +++ b/docs/sphinx/source/wiki/TutorialWorldIntroduction.rst @@ -1,5 +1,3 @@ -Introducing the Tutorial world area - Tutorial World Introduction =========================== diff --git a/docs/sphinx/source/wiki/Typeclasses.rst b/docs/sphinx/source/wiki/Typeclasses.rst index 047a074149..c041bd0314 100644 --- a/docs/sphinx/source/wiki/Typeclasses.rst +++ b/docs/sphinx/source/wiki/Typeclasses.rst @@ -1,5 +1,3 @@ -Descibing how Objects and Typeclasses work - Typeclassed entities ==================== diff --git a/docs/sphinx/source/wiki/UnitTesting.rst b/docs/sphinx/source/wiki/UnitTesting.rst index 5204ced263..789e19e2d6 100644 --- a/docs/sphinx/source/wiki/UnitTesting.rst +++ b/docs/sphinx/source/wiki/UnitTesting.rst @@ -1,5 +1,3 @@ -Using and writing unit tests for Evennia. - Unit Testing ============ diff --git a/docs/sphinx/source/wiki/UsingMUXAsAStandard.rst b/docs/sphinx/source/wiki/UsingMUXAsAStandard.rst index ef24aa53f5..b98ba576a0 100644 --- a/docs/sphinx/source/wiki/UsingMUXAsAStandard.rst +++ b/docs/sphinx/source/wiki/UsingMUXAsAStandard.rst @@ -1,5 +1,3 @@ -Our policy on default commands - The 'MUX-like' default of Evennia ================================= diff --git a/docs/sphinx/source/wiki/WebFeatures.rst b/docs/sphinx/source/wiki/WebFeatures.rst index 41c5113310..c8e6c78ea6 100644 --- a/docs/sphinx/source/wiki/WebFeatures.rst +++ b/docs/sphinx/source/wiki/WebFeatures.rst @@ -1,5 +1,3 @@ -Summarizes the web feautures of Evennia - Web Features ============ diff --git a/docs/sphinx/source/wiki/Workshop.rst b/docs/sphinx/source/wiki/Workshop.rst index 18ccba908d..f960922801 100644 --- a/docs/sphinx/source/wiki/Workshop.rst +++ b/docs/sphinx/source/wiki/Workshop.rst @@ -1,5 +1,3 @@ -Devel workshop - rtclient protocol ================= diff --git a/docs/sphinx/source/wiki/WorkshopDefaultGame.rst b/docs/sphinx/source/wiki/WorkshopDefaultGame.rst index ae68711958..b357d24fe2 100644 --- a/docs/sphinx/source/wiki/WorkshopDefaultGame.rst +++ b/docs/sphinx/source/wiki/WorkshopDefaultGame.rst @@ -1,5 +1,3 @@ -Workshop: Default-game whitepage - **Status Update**:*There does not seem to be any active development on this by the original initiator (rcaskey). As far as I know there is no active game code written apart from a Smaug area converter (how diff --git a/docs/sphinx/wiki2rest/wiki2rest.py b/docs/sphinx/wiki2rest/wiki2rest.py index 4ad3991975..ffb0af0a1c 100755 --- a/docs/sphinx/wiki2rest/wiki2rest.py +++ b/docs/sphinx/wiki2rest/wiki2rest.py @@ -144,7 +144,7 @@ def wiki2rest(): #subprocess.call(["python", "get_wiki_as_html.py"]) # use wikify importer print " wikify: converting wiki -> html ..." - subprocess.call(["python", "wikify.py", "-e", "-m", "-c", "-a", "-s", "wiki", "-d", "html"]) + subprocess.call(["python", "wikify.py", "-r", "-e", "-m", "-c", "-a", "-s", "wiki", "-d", "html"]) # convert from html to rest with pandoc htmlfilenames = [fn for fn in os.listdir(HTML_DIR)