Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated the ReST documentation.

Browse source
This commit is contained in:
Griatch 2013-05-15 23:49:38 +02:00
parent d30a79386f
commit cc12dc36fa
34 changed files with 935 additions and 759 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/sphinx/README.txt Normal file
View file

@ -0,0 +1,18 @@
Wiki convertion and autodocs
----------------------------
The source/ directory contains Evennia's wiki documentation converted
to ReST form. This can be built to a html document by installing
python-sphinx (sphinx-doc.org) and running 'make html' from this
directory. The output will appear in under build/ - point your browser
to the index.html file.
If you want to (re-)build the documentation yourself, wiki2rest/
contains programs for converting Evennia's wiki documentation to ReST
files. Read the header of wiki2rest.py for setting up the converter.
The src2rest folder contains a reprecated program for building
documented ReST source code from Evennia's documentation. You can
arguably get as good autodocs using doxygen.