Removed mention of ROOT_DIR, deleted docs/ directory and moved locale/ under evennia/.
This commit is contained in:
Griatch
parent
0115db3805
commit
dc20174531
7 changed files with 3 additions and 411 deletions
118
docs/README.txt
118
docs/README.txt
|
|
@ -1,118 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
EVENNIA DOCUMENTATION
|
|
||||||
=====================
|
|
||||||
|
|
||||||
|
|
||||||
- Evennia is extensively documented. Our manual is the
|
|
||||||
continuously updating online wiki,
|
|
||||||
|
|
||||||
https://github.com/evennia/evennia/wiki
|
|
||||||
|
|
||||||
- Snapshots of the manual are also mirrored in reST
|
|
||||||
form to ReadTheDocs:
|
|
||||||
|
|
||||||
http://evennia.readthedocs.org/en/latest/
|
|
||||||
|
|
||||||
- You can also ask for help from the evennia community,
|
|
||||||
|
|
||||||
http://groups.google.com/group/evennia
|
|
||||||
|
|
||||||
- Or by visiting our irc channel,
|
|
||||||
|
|
||||||
#evennia on the Freenode network
|
|
||||||
|
|
||||||
-------------------
|
|
||||||
* Doxygen auto-docs
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
- Install doxygen (v1.7+)
|
|
||||||
|
|
||||||
Doxygen is available for most platforms from
|
|
||||||
|
|
||||||
http://www.stack.nl/~dimitri/doxygen/
|
|
||||||
|
|
||||||
or through your package manager in Linux.
|
|
||||||
|
|
||||||
- Run
|
|
||||||
|
|
||||||
doxygen config.dox
|
|
||||||
|
|
||||||
This will create the auto-docs in a folder 'html'.
|
|
||||||
|
|
||||||
- Start your web browser and point it to
|
|
||||||
|
|
||||||
<evenniadir>/docs/html/index.html
|
|
||||||
|
|
||||||
- If you prefer a pdf version for printing, use LaTeX by
|
|
||||||
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. You need the
|
|
||||||
LaTeX processing system installed, then enter the new
|
|
||||||
latex/ folder and run
|
|
||||||
|
|
||||||
make
|
|
||||||
|
|
||||||
This will create the pdf. Be warned however that the pdf
|
|
||||||
docs are many hundreds of pages and the automatic formatting
|
|
||||||
of doxygen is not always succeeding.
|
|
||||||
|
|
||||||
- Doxyfile is allows for plenty of configuration to get the
|
|
||||||
docs to look the way you want. You can also output to other
|
|
||||||
formats suitable for various developer environments, Windows
|
|
||||||
help files etc.
|
|
||||||
|
|
||||||
------------------------
|
|
||||||
* Sphinx Manuals
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
If you want to build the reST manuals yourself, you basically need to
|
|
||||||
convert the wiki. First place yourself in a location where you want
|
|
||||||
to clone the wiki repo to, then clone it:
|
|
||||||
|
|
||||||
git clone https://github.com/evennia/evennia.wiki.git
|
|
||||||
|
|
||||||
- Enter this directory and check out the sphinx branch:
|
|
||||||
|
|
||||||
git checkout sphinx
|
|
||||||
|
|
||||||
This branch has, apart from all the wiki pages (*.md files), also has a
|
|
||||||
an extra directory sphinx/ that will hold the converted data.
|
|
||||||
|
|
||||||
- You need Pandoc for the markdown-to-reST conversion:
|
|
||||||
|
|
||||||
http://johnmacfarlane.net/pandoc/installing.html
|
|
||||||
|
|
||||||
You need a rather recent version. The versions coming with some linux
|
|
||||||
repos are too old to support "github-flavoured markdown" conversion.
|
|
||||||
See that page for getting the Haskill build environment in that case.
|
|
||||||
|
|
||||||
- You also need sphinx,
|
|
||||||
|
|
||||||
http://sphinx-doc.org/
|
|
||||||
|
|
||||||
You can most likely get it with 'pip install sphinx' under Linux.
|
|
||||||
|
|
||||||
- With all this in place, go to the pylib/ folder and run the
|
|
||||||
converter script:
|
|
||||||
|
|
||||||
python update_rest_docs.py
|
|
||||||
|
|
||||||
If all goes well, you will see all the wiki pages getting converted.
|
|
||||||
The converted *.rst files will end up in the sphinx/ directory.
|
|
||||||
|
|
||||||
- Finally, go to sphinx/ and run
|
|
||||||
|
|
||||||
make html
|
|
||||||
|
|
||||||
If sphinx is installed, this will create the html files in
|
|
||||||
sphinx/.build. To look at them, point your browser to
|
|
||||||
|
|
||||||
<path-to-wiki-repo>/sphinx/.build/index.html
|
|
||||||
|
|
||||||
|
|
||||||
288
docs/config.dox
288
docs/config.dox
|
|
@ -1,288 +0,0 @@
|
||||||
# Doxyfile 1.8.1.2
|
|
||||||
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# Project related configuration options
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
DOXYFILE_ENCODING = UTF-8
|
|
||||||
PROJECT_NAME = "Evennia"
|
|
||||||
PROJECT_NUMBER = Git-Beta
|
|
||||||
PROJECT_BRIEF = Python MUD development system
|
|
||||||
PROJECT_LOGO = ../../evennia/web/media/images/evennia_logo.png
|
|
||||||
OUTPUT_DIRECTORY =
|
|
||||||
CREATE_SUBDIRS = NO
|
|
||||||
OUTPUT_LANGUAGE = English
|
|
||||||
BRIEF_MEMBER_DESC = YES
|
|
||||||
REPEAT_BRIEF = YES
|
|
||||||
ABBREVIATE_BRIEF =
|
|
||||||
ALWAYS_DETAILED_SEC = NO
|
|
||||||
INLINE_INHERITED_MEMB = NO
|
|
||||||
FULL_PATH_NAMES = YES
|
|
||||||
STRIP_FROM_PATH =
|
|
||||||
STRIP_FROM_INC_PATH =
|
|
||||||
SHORT_NAMES = NO
|
|
||||||
JAVADOC_AUTOBRIEF = NO
|
|
||||||
QT_AUTOBRIEF = NO
|
|
||||||
MULTILINE_CPP_IS_BRIEF = NO
|
|
||||||
INHERIT_DOCS = YES
|
|
||||||
SEPARATE_MEMBER_PAGES = NO
|
|
||||||
TAB_SIZE = 8
|
|
||||||
ALIASES =
|
|
||||||
TCL_SUBST =
|
|
||||||
OPTIMIZE_OUTPUT_FOR_C = NO
|
|
||||||
OPTIMIZE_OUTPUT_JAVA = NO
|
|
||||||
OPTIMIZE_FOR_FORTRAN = NO
|
|
||||||
OPTIMIZE_OUTPUT_VHDL = NO
|
|
||||||
EXTENSION_MAPPING =
|
|
||||||
MARKDOWN_SUPPORT = YES
|
|
||||||
BUILTIN_STL_SUPPORT = NO
|
|
||||||
CPP_CLI_SUPPORT = NO
|
|
||||||
SIP_SUPPORT = NO
|
|
||||||
IDL_PROPERTY_SUPPORT = YES
|
|
||||||
DISTRIBUTE_GROUP_DOC = NO
|
|
||||||
SUBGROUPING = YES
|
|
||||||
INLINE_GROUPED_CLASSES = NO
|
|
||||||
INLINE_SIMPLE_STRUCTS = NO
|
|
||||||
TYPEDEF_HIDES_STRUCT = NO
|
|
||||||
SYMBOL_CACHE_SIZE = 0
|
|
||||||
LOOKUP_CACHE_SIZE = 0
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# Build related configuration options
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
EXTRACT_ALL = YES
|
|
||||||
EXTRACT_PRIVATE = NO
|
|
||||||
EXTRACT_PACKAGE = NO
|
|
||||||
EXTRACT_STATIC = YES
|
|
||||||
EXTRACT_LOCAL_CLASSES = YES
|
|
||||||
EXTRACT_LOCAL_METHODS = NO
|
|
||||||
EXTRACT_ANON_NSPACES = NO
|
|
||||||
HIDE_UNDOC_MEMBERS = NO
|
|
||||||
HIDE_UNDOC_CLASSES = NO
|
|
||||||
HIDE_FRIEND_COMPOUNDS = NO
|
|
||||||
HIDE_IN_BODY_DOCS = NO
|
|
||||||
INTERNAL_DOCS = NO
|
|
||||||
CASE_SENSE_NAMES = YES
|
|
||||||
HIDE_SCOPE_NAMES = NO
|
|
||||||
SHOW_INCLUDE_FILES = YES
|
|
||||||
FORCE_LOCAL_INCLUDES = NO
|
|
||||||
INLINE_INFO = YES
|
|
||||||
SORT_MEMBER_DOCS = YES
|
|
||||||
SORT_BRIEF_DOCS = NO
|
|
||||||
SORT_MEMBERS_CTORS_1ST = NO
|
|
||||||
SORT_GROUP_NAMES = NO
|
|
||||||
SORT_BY_SCOPE_NAME = NO
|
|
||||||
STRICT_PROTO_MATCHING = NO
|
|
||||||
GENERATE_TODOLIST = YES
|
|
||||||
GENERATE_TESTLIST = YES
|
|
||||||
GENERATE_BUGLIST = YES
|
|
||||||
GENERATE_DEPRECATEDLIST= YES
|
|
||||||
ENABLED_SECTIONS =
|
|
||||||
MAX_INITIALIZER_LINES = 30
|
|
||||||
SHOW_USED_FILES = YES
|
|
||||||
SHOW_FILES = YES
|
|
||||||
SHOW_NAMESPACES = YES
|
|
||||||
FILE_VERSION_FILTER =
|
|
||||||
LAYOUT_FILE =
|
|
||||||
CITE_BIB_FILES =
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to warning and progress messages
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
QUIET = NO
|
|
||||||
WARNINGS = YES
|
|
||||||
WARN_IF_UNDOCUMENTED = YES
|
|
||||||
WARN_IF_DOC_ERROR = YES
|
|
||||||
WARN_NO_PARAMDOC = NO
|
|
||||||
WARN_FORMAT = "$file:$line: $text"
|
|
||||||
WARN_LOGFILE =
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to the input files
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
INPUT = ../..
|
|
||||||
INPUT_ENCODING = UTF-8
|
|
||||||
FILE_PATTERNS = *.py
|
|
||||||
RECURSIVE = YES
|
|
||||||
EXCLUDE = ../../docs
|
|
||||||
EXCLUDE_SYMLINKS = NO
|
|
||||||
EXCLUDE_PATTERNS = 0*.py
|
|
||||||
EXCLUDE_SYMBOLS =
|
|
||||||
EXAMPLE_PATH =
|
|
||||||
EXAMPLE_PATTERNS =
|
|
||||||
EXAMPLE_RECURSIVE = NO
|
|
||||||
IMAGE_PATH =
|
|
||||||
INPUT_FILTER =
|
|
||||||
FILTER_PATTERNS =
|
|
||||||
FILTER_SOURCE_FILES = NO
|
|
||||||
FILTER_SOURCE_PATTERNS =
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to source browsing
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
SOURCE_BROWSER = YES
|
|
||||||
INLINE_SOURCES = NO
|
|
||||||
STRIP_CODE_COMMENTS = YES
|
|
||||||
REFERENCED_BY_RELATION = NO
|
|
||||||
REFERENCES_RELATION = NO
|
|
||||||
REFERENCES_LINK_SOURCE = YES
|
|
||||||
USE_HTAGS = NO
|
|
||||||
VERBATIM_HEADERS = YES
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to the alphabetical class index
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
ALPHABETICAL_INDEX = YES
|
|
||||||
COLS_IN_ALPHA_INDEX = 8
|
|
||||||
IGNORE_PREFIX =
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to the HTML output
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
GENERATE_HTML = YES
|
|
||||||
HTML_OUTPUT = html
|
|
||||||
HTML_FILE_EXTENSION = .html
|
|
||||||
HTML_HEADER =
|
|
||||||
HTML_FOOTER =
|
|
||||||
HTML_STYLESHEET =
|
|
||||||
HTML_EXTRA_FILES =
|
|
||||||
HTML_COLORSTYLE_HUE = 220
|
|
||||||
HTML_COLORSTYLE_SAT = 100
|
|
||||||
HTML_COLORSTYLE_GAMMA = 80
|
|
||||||
HTML_TIMESTAMP = YES
|
|
||||||
HTML_DYNAMIC_SECTIONS = NO
|
|
||||||
HTML_INDEX_NUM_ENTRIES = 100
|
|
||||||
GENERATE_DOCSET = NO
|
|
||||||
DOCSET_FEEDNAME = "Doxygen generated docs"
|
|
||||||
DOCSET_BUNDLE_ID = org.doxygen.Project
|
|
||||||
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
|
|
||||||
DOCSET_PUBLISHER_NAME = Publisher
|
|
||||||
GENERATE_HTMLHELP = NO
|
|
||||||
CHM_FILE =
|
|
||||||
HHC_LOCATION =
|
|
||||||
GENERATE_CHI = NO
|
|
||||||
CHM_INDEX_ENCODING =
|
|
||||||
BINARY_TOC = NO
|
|
||||||
TOC_EXPAND = YES
|
|
||||||
GENERATE_QHP = NO
|
|
||||||
QCH_FILE =
|
|
||||||
QHP_NAMESPACE = org.doxygen.Project
|
|
||||||
QHP_VIRTUAL_FOLDER = doc
|
|
||||||
QHP_CUST_FILTER_NAME =
|
|
||||||
QHP_CUST_FILTER_ATTRS =
|
|
||||||
QHP_SECT_FILTER_ATTRS =
|
|
||||||
QHG_LOCATION =
|
|
||||||
GENERATE_ECLIPSEHELP = NO
|
|
||||||
ECLIPSE_DOC_ID = org.doxygen.Project
|
|
||||||
DISABLE_INDEX = YES
|
|
||||||
GENERATE_TREEVIEW = YES
|
|
||||||
ENUM_VALUES_PER_LINE = 4
|
|
||||||
TREEVIEW_WIDTH = 250
|
|
||||||
EXT_LINKS_IN_WINDOW = NO
|
|
||||||
FORMULA_FONTSIZE = 10
|
|
||||||
FORMULA_TRANSPARENT = YES
|
|
||||||
USE_MATHJAX = NO
|
|
||||||
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
|
||||||
MATHJAX_EXTENSIONS =
|
|
||||||
SEARCHENGINE = YES
|
|
||||||
SERVER_BASED_SEARCH = NO
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to the LaTeX output
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
GENERATE_LATEX = NO
|
|
||||||
LATEX_OUTPUT = latex
|
|
||||||
LATEX_CMD_NAME = latex
|
|
||||||
MAKEINDEX_CMD_NAME = makeindex
|
|
||||||
COMPACT_LATEX = NO
|
|
||||||
PAPER_TYPE = a4
|
|
||||||
EXTRA_PACKAGES =
|
|
||||||
LATEX_HEADER =
|
|
||||||
LATEX_FOOTER =
|
|
||||||
PDF_HYPERLINKS = YES
|
|
||||||
USE_PDFLATEX = YES
|
|
||||||
LATEX_BATCHMODE = NO
|
|
||||||
LATEX_HIDE_INDICES = NO
|
|
||||||
LATEX_SOURCE_CODE = NO
|
|
||||||
LATEX_BIB_STYLE = plain
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to the RTF output
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
GENERATE_RTF = NO
|
|
||||||
RTF_OUTPUT = rtf
|
|
||||||
COMPACT_RTF = NO
|
|
||||||
RTF_HYPERLINKS = NO
|
|
||||||
RTF_STYLESHEET_FILE =
|
|
||||||
RTF_EXTENSIONS_FILE =
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to the man page output
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
GENERATE_MAN = NO
|
|
||||||
MAN_OUTPUT = man
|
|
||||||
MAN_EXTENSION = .3
|
|
||||||
MAN_LINKS = NO
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to the XML output
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
GENERATE_XML = NO
|
|
||||||
XML_OUTPUT = xml
|
|
||||||
XML_SCHEMA =
|
|
||||||
XML_DTD =
|
|
||||||
XML_PROGRAMLISTING = YES
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options for the AutoGen Definitions output
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
GENERATE_AUTOGEN_DEF = NO
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# configuration options related to the Perl module output
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
GENERATE_PERLMOD = NO
|
|
||||||
PERLMOD_LATEX = NO
|
|
||||||
PERLMOD_PRETTY = YES
|
|
||||||
PERLMOD_MAKEVAR_PREFIX =
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# Configuration options related to the preprocessor
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
ENABLE_PREPROCESSING = YES
|
|
||||||
MACRO_EXPANSION = NO
|
|
||||||
EXPAND_ONLY_PREDEF = NO
|
|
||||||
SEARCH_INCLUDES = YES
|
|
||||||
INCLUDE_PATH =
|
|
||||||
INCLUDE_FILE_PATTERNS =
|
|
||||||
PREDEFINED =
|
|
||||||
EXPAND_AS_DEFINED =
|
|
||||||
SKIP_FUNCTION_MACROS = YES
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# Configuration::additions related to external references
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
TAGFILES =
|
|
||||||
GENERATE_TAGFILE =
|
|
||||||
ALLEXTERNALS = NO
|
|
||||||
EXTERNAL_GROUPS = YES
|
|
||||||
PERL_PATH = /usr/bin/perl
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
# Configuration options related to the dot tool
|
|
||||||
#---------------------------------------------------------------------------
|
|
||||||
CLASS_DIAGRAMS = YES
|
|
||||||
MSCGEN_PATH =
|
|
||||||
HIDE_UNDOC_RELATIONS = YES
|
|
||||||
HAVE_DOT = NO
|
|
||||||
DOT_NUM_THREADS = 0
|
|
||||||
DOT_FONTNAME = Helvetica
|
|
||||||
DOT_FONTSIZE = 10
|
|
||||||
DOT_FONTPATH =
|
|
||||||
CLASS_GRAPH = YES
|
|
||||||
COLLABORATION_GRAPH = YES
|
|
||||||
GROUP_GRAPHS = YES
|
|
||||||
UML_LOOK = NO
|
|
||||||
UML_LIMIT_NUM_FIELDS = 10
|
|
||||||
TEMPLATE_RELATIONS = NO
|
|
||||||
INCLUDE_GRAPH = YES
|
|
||||||
INCLUDED_BY_GRAPH = YES
|
|
||||||
CALL_GRAPH = NO
|
|
||||||
CALLER_GRAPH = NO
|
|
||||||
GRAPHICAL_HIERARCHY = YES
|
|
||||||
DIRECTORY_GRAPH = YES
|
|
||||||
DOT_IMAGE_FORMAT = png
|
|
||||||
INTERACTIVE_SVG = NO
|
|
||||||
DOT_PATH =
|
|
||||||
DOTFILE_DIRS =
|
|
||||||
MSCFILE_DIRS =
|
|
||||||
DOT_GRAPH_MAX_NODES = 50
|
|
||||||
MAX_DOT_GRAPH_DEPTH = 0
|
|
||||||
DOT_TRANSPARENT = NO
|
|
||||||
DOT_MULTI_TARGETS = YES
|
|
||||||
GENERATE_LEGEND = YES
|
|
||||||
DOT_CLEANUP = YES
|
|
||||||
|
|
@ -103,13 +103,11 @@ WEBSOCKET_INTERFACES = ['0.0.0.0']
|
||||||
# This determine's whether Evennia's custom admin page is used, or if the
|
# This determine's whether Evennia's custom admin page is used, or if the
|
||||||
# standard Django admin is used.
|
# standard Django admin is used.
|
||||||
EVENNIA_ADMIN = True
|
EVENNIA_ADMIN = True
|
||||||
# The path to the root directory
|
|
||||||
ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
|
||||||
|
|
||||||
# Path to the lib directory containing the bulk of the codebase's code.
|
# Path to the lib directory containing the bulk of the codebase's code.
|
||||||
EVENNIA_DIR = os.path.join(ROOT_DIR, 'evennia')
|
EVENNIA_DIR = os.path.dirname(os.path.abspath(__file__))
|
||||||
# Path to the game directory (containing the database file if using sqlite).
|
# Path to the game directory (containing the database file if using sqlite).
|
||||||
if test:
|
if test:
|
||||||
|
# we must run tests from an initialized game directory
|
||||||
GAME_DIR = os.getcwd()
|
GAME_DIR = os.getcwd()
|
||||||
else:
|
else:
|
||||||
# Fallback location
|
# Fallback location
|
||||||
|
|
@ -530,7 +528,7 @@ SESSION_EXPIRE_AT_BROWSER_CLOSE = False
|
||||||
# to load the internationalization machinery.
|
# to load the internationalization machinery.
|
||||||
USE_I18N = False
|
USE_I18N = False
|
||||||
# Where to find locales (no need to change this, most likely)
|
# Where to find locales (no need to change this, most likely)
|
||||||
LOCALE_PATHS = [os.path.join(ROOT_DIR, "locale/")]
|
LOCALE_PATHS = [os.path.join(EVENNIA_DIR, "locale/")]
|
||||||
# This should be turned off unless you want to do tests with Django's
|
# This should be turned off unless you want to do tests with Django's
|
||||||
# development webserver (normally Evennia runs its own server)
|
# development webserver (normally Evennia runs its own server)
|
||||||
SERVE_MEDIA = False
|
SERVE_MEDIA = False
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue