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,79 @@
Developer Central
=================
This page serves as a central nexus for useful information regarding
coding using the Evennia codebase, and also for development of the
codebase itself. Everyone is welcome to help out! If you have any
questions, please feel free to ask them in the `Forum/Discussion
Group <http://www.evennia.com/discussions>`_. Bugs should be reported to
the `Issue tracker <http://code.google.com/p/evennia/issues/list>`_. You
can find more links to Evennia resources from the `Links <Links.html>`_
page.
General Evennia development information
---------------------------------------
- `Evennia Licensing FAQ <Licensing.html>`_
- `Contributing code to Evennia <Contributing.html>`_
- `Evennia Code Style
Guide <http://evennia.googlecode.com/svn/trunk/CODING_STYLE>`_
(Important!)
- `Policy for 'MUX-like' default commands <UsingMUXAsAStandard.html>`_
<wiki:comment>
- `Setting up a Bazaar environment for coding <BazaarDevel.html>`_
</wiki:comment>
Evennia Component Documentation
-------------------------------
`Directory Overview <DirectoryOverview.html>`_
`Portal and Server <PortalAndServer.html>`_
`Commands <Commands.html>`_
`Typeclass system <Typeclasses.html>`_
- `Objects <Objects.html>`_
- `Scripts <Scripts.html>`_
- `Players <Players.html>`_
- `Attributes <Attributes.html>`_
`Locks and Permissions <Locks.html>`_
`Communications <Communications.html>`_
`Help System <HelpSystem.html>`_
`Nicks <Nicks.html>`_
`Sessions and Protocols <SessionProtocols.html>`_
`Web features <WebFeatures.html>`_
Programming Evennia
-------------------
- `Running and Testing Python code from inside the
game <ExecutePythonCode.html>`_
- `Running and writing unit tests for Evennia <UnitTesting.html>`_
- `Removing Colour from your game - tutorial on redefining typeclass
methods <RemovingColour.html>`_
- `Adding a Command prompt <CommandPrompt.html>`_
- `Running processes asynchronously <AsyncProcess.html>`_
Work in Progress - Developer brainstorms and whitepages
-------------------------------------------------------
*In this section, contributors may suggest, discuss and plan out new
features and ideas. Items here may or may not make it into Evennia down
the road.*
- `Basic game system implementation <WorkshopDefaultGame.html>`_
- `Rtclient protocol <Workshop.html>`_
- `Summary of changes <EvenniaDevel.html>`_ of latest version vs old
Evennia (pre aug2010)