Added Sphinx (reST-style) conversion of Evennia documentation to docs/. This is an auto-generated conversion directly from the Wiki, so it's not custom-written in any way (will also make it easy to update). You need Sphinx to compile the sources into fancy pages. Supporting sphinx is to make documentation easier to print and view offline. Currently no sphinx src-code viewing is activated by default, it gives too many spurious errors (the converters are in the repo though if you're interested in experimenting). So for offline autodocs, doxygen is still to recommend.

This commit is contained in:
Griatch 2011-09-10 23:44:49 +02:00
parent 5a2b9e27a0
commit bd0079a39d
65 changed files with 9394 additions and 143 deletions

View file

@ -0,0 +1,84 @@
.. Evennia documentation master file, created by
sphinx-quickstart on Sat Sep 10 14:19:20 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Evennia's documentation!
===================================
This is `Evennia <http://www.evennia.com>`_'s sphinx-based
documentation. It is built from the `online wiki <http://code.google.com/p/evennia/wiki/Index?tm=6>`_ at regular
intervals.
Text documentation
-------------------
.. toctree::
:titlesonly:
Manual <wiki/Index>
How to give and get help <wiki/HowToGetAndGiveHelp>
Evennia Links <wiki/Links>
.. Code
.. -----
.. .. toctree::
.. :titlesonly:
.. Browse Code <code/modules>
.. toctree::
:hidden:
wiki/Index
wiki/EvenniaIntroduction
wiki/SoftCode
wiki/GettingStarted
wiki/AdminDocs
wiki/ChoosingAnSQLServer
wiki/StartStopReload
wiki/UpdatingYourGame
wiki/Internationalization
wiki/StaffVersionControl
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/BazaarDevel
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