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

@ -1,6 +1,7 @@
===========
DOCS README
-----------
===========
* Evennia docs and manual
@ -17,9 +18,44 @@ DOCS README
#evennia on the Freenode network
* Evennia source auto-docs
------------------------
* Sphinx Manuals
------------------------
The folder docs/sphinx contains a source tree with Evennia's online wiki
formatted into reStructuredText for easy (and good looking!) offline
browsing or printing.
To build the sources you need to install Sphinx. Linux users can get it
through their package managers (in Debian it's called python-sphinx). Or
you can download it here:
http://sphinx.pocoo.org/index.html
Go into docs/sphinx and run
make html
You will see a lot of output (and probably some errors too, Evennia's docs
are not formatted to reST format by default). When done, point your
web browser to docs/sphinx/build/html/index.html to see the nice manual.
In this folder you can build the developer auto-docs
If you don't want html output, you can output to a host of other formats,
use just "make" for a list of options.
Note: In docs/sphinx are two more dirs, wiki2rest and src2rest. These
can be used to create reST-formatted documentation from raw sources.
They depend on a host of external libraries however, so best stay away
from them unless you are an Evennia dev. Read the headers of the
respective *.py files for instructions.
-------------------
* Doxygen auto-docs
-------------------
In docs/doxygen you can build the developer auto-docs
(a fancy searchable index of the entire source tree).
This makes use of doxygen, a doc generator that parses
the source tree and creates docs on the fly.
@ -32,16 +68,16 @@ DOCS README
- Run
> doxygen Doxyfile
> doxygen config.dox
This will create the auto-docs in a folder 'html'.
This will create the auto-docs in a folder 'doxygen/html'.
- Start your web browser and point it to
<evenniadir>/docs/html/index.html
<evenniadir>/docs/doxygen/html/index.html
- If you prefer a pdf version for printing, use LaTeX by
activating the relevant section in Doxyfile. Run the
activating the relevant section in config.dox. Run the
doxygen command again as above and a new folder 'latex'
will be created with the latex sources. With the latex
processing system installed, then run