diff --git a/docs/README b/docs/README new file mode 100644 index 0000000000..2fc3d5c6ca --- /dev/null +++ b/docs/README @@ -0,0 +1,14 @@ + +* Evennia documentation + + To build the auto-documentation (overview of all the sources, with comments), read the + instructions in ./doxygen. + +The most updated 'manual' is currently the online wiki, at + + http://code.google.com/p/evennia/wiki/Index?tm=6 + +You can ask for help from the evennia community here: + + http://groups.google.com/group/evennia + diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index e2b87e07b8..79e72f5eed 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -272,4 +272,4 @@ DOT_CLEANUP = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine #--------------------------------------------------------------------------- -SEARCHENGINE = NO +SEARCHENGINE = YES diff --git a/docs/doxygen/README b/docs/doxygen/README new file mode 100644 index 0000000000..3ba97345cf --- /dev/null +++ b/docs/doxygen/README @@ -0,0 +1,8 @@ +To create the developer auto-docs, install doxygen (it's available for most platforms here: + http://www.stack.nl/~dimitri/doxygen/ ), and run + +> doxygen Doxyfile + +in this directory. This will create the auto-docs in ./output/html. To read, point your web browser to +evennia/docs/doxygen/output/html/index.html. If you prefer a pdf / paper hardcopy, install the LaTeX +system and activate the relevant section in Doxyfile.