evennia/docs/1.0-dev/api/evennia.web.html
2020-06-14 21:48:02 +02:00

277 lines
No EOL
9.5 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>evennia.web package &mdash; Evennia 1.0-dev documentation</title>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Evennia 1.0-dev documentation" href="../index.html"/>
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> Evennia
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">evennia.web package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-evennia.web.urls">evennia.web.urls module</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Evennia</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li>evennia.web package</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/evennia.web.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-evennia.web">
<span id="evennia-web-package"></span><h1>evennia.web package<a class="headerlink" href="#module-evennia.web" title="Permalink to this headline"></a></h1>
<p>This sub-package holds the web presence of Evennia, using normal
Django to relate the database contents to web pages. Also the basic
webclient and the website are defined in here (the webserver itself is
found under the <cite>server</cite> package).</p>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.web.api.html">evennia.web.api package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.html#module-evennia.web.api.filters">evennia.web.api.filters module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.html#module-evennia.web.api.permissions">evennia.web.api.permissions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.html#module-evennia.web.api.serializers">evennia.web.api.serializers module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.html#module-evennia.web.api.tests">evennia.web.api.tests module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.html#module-evennia.web.api.urls">evennia.web.api.urls module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.api.html#module-evennia.web.api.views">evennia.web.api.views module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.web.utils.html">evennia.web.utils package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.backends">evennia.web.utils.backends module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.general_context">evennia.web.utils.general_context module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.middleware">evennia.web.utils.middleware module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.utils.html#module-evennia.web.utils.tests">evennia.web.utils.tests module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.web.webclient.html">evennia.web.webclient package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.webclient.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.webclient.html#module-evennia.web.webclient.urls">evennia.web.webclient.urls module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.webclient.html#module-evennia.web.webclient.views">evennia.web.webclient.views module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.web.website.html">evennia.web.website package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.website.templatetags.html">evennia.web.website.templatetags package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.templatetags.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.web.website.templatetags.html#module-evennia.web.website.templatetags.addclass">evennia.web.website.templatetags.addclass module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.forms">evennia.web.website.forms module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.tests">evennia.web.website.tests module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.urls">evennia.web.website.urls module</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.web.website.html#module-evennia.web.website.views">evennia.web.website.views module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-evennia.web.urls">
<span id="evennia-web-urls-module"></span><h2>evennia.web.urls module<a class="headerlink" href="#module-evennia.web.urls" title="Permalink to this headline"></a></h2>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, The Evennia developer community.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> and ❤️ using a custom <a href="https://github.com/LinxiFan/Sphinx-theme">theme</a> based on <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'1.0-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>