Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-17 13:26:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/sphinx
History
Griatch 64a30c655d Updated ReST docs.
2013-12-02 16:43:44 +01:00
..
source Updated ReST docs. 2013-12-02 16:43:44 +01:00
src2rest Updated the ReST documentation. 2013-05-15 23:49:38 +02:00
wiki2rest Updated the ReST documentation. 2013-05-15 23:49:38 +02:00
make.bat 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. 2011-09-10 23:44:49 +02:00
Makefile 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. 2011-09-10 23:44:49 +02:00
README.txt Updated the ReST documentation. 2013-05-15 23:49:38 +02:00

README.txt 


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.