Updated HTML docs

2026-04-04 06:57:16 +02:00 · 2020-10-15 01:31:30 +02:00 · 2020-10-15 01:31:30 +02:00 · edf9ca4c4b
commit edf9ca4c4b
parent dc00b6bf65
1252 changed files with 40437 additions and 27044 deletions
--- a/docs/1.0-dev/api/evennia.help.admin.html
+++ b/docs/1.0-dev/api/evennia.help.admin.html
@ -1,9 +1,10 @@

 <!DOCTYPE html>

-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
  <head>
    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>evennia.help.admin &#8212; Evennia 1.0-dev documentation</title>
    <link rel="stylesheet" href="../_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -25,7 +26,8 @@
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">evennia.help.admin</a></li> 
      </ul>
    </div>  

@ -37,124 +39,125 @@
  <div class="section" id="module-evennia.help.admin">
 <span id="evennia-help-admin"></span><h1>evennia.help.admin<a class="headerlink" href="#module-evennia.help.admin" title="Permalink to this headline">¶</a></h1>
 <p>This defines how to edit help entries in Admin.</p>
-<dl class="class">
+<dl class="py class">
 <dt id="evennia.help.admin.HelpTagInline">
-<em class="property">class </em><code class="sig-prename descclassname">evennia.help.admin.</code><code class="sig-name descname">HelpTagInline</code><span class="sig-paren">(</span><em class="sig-param">parent_model</em>, <em class="sig-param">admin_site</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpTagInline" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="sig-prename descclassname">evennia.help.admin.</code><code class="sig-name descname">HelpTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpTagInline" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.admin.html#evennia.typeclasses.admin.TagInline" title="evennia.typeclasses.admin.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.admin.TagInline</span></code></a></p>
-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpTagInline.model">
 <code class="sig-name descname">model</code><a class="headerlink" href="#evennia.help.admin.HelpTagInline.model" title="Permalink to this definition">¶</a></dt>
 <dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.help.models.HelpEntry_db_tags</span></code></p>
 </dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpTagInline.related_field">
 <code class="sig-name descname">related_field</code><em class="property"> = 'helpentry'</em><a class="headerlink" href="#evennia.help.admin.HelpTagInline.related_field" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.help.admin.HelpTagInline.media">
 <em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.help.admin.HelpTagInline.media" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

-<dl class="class">
+<dl class="py class">
 <dt id="evennia.help.admin.HelpEntryForm">
 <em class="property">class </em><code class="sig-prename descclassname">evennia.help.admin.</code><code class="sig-name descname">HelpEntryForm</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">files=None</em>, <em class="sig-param">auto_id='id_%s'</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">initial=None</em>, <em class="sig-param">error_class=&lt;class 'django.forms.utils.ErrorList'&gt;</em>, <em class="sig-param">label_suffix=None</em>, <em class="sig-param">empty_permitted=False</em>, <em class="sig-param">instance=None</em>, <em class="sig-param">use_required_attribute=None</em>, <em class="sig-param">renderer=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpEntryForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpEntryForm" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.forms.models.ModelForm</span></code></p>
 <p>Defines how to display the help entry</p>
-<dl class="class">
+<dl class="py class">
 <dt id="evennia.help.admin.HelpEntryForm.Meta">
 <em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpEntryForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.Meta" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryForm.Meta.model">
 <code class="sig-name descname">model</code><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.Meta.model" title="Permalink to this definition">¶</a></dt>
 <dd><p>alias of <a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry" title="evennia.help.models.HelpEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.help.models.HelpEntry</span></code></a></p>
 </dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryForm.Meta.fields">
 <code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.Meta.fields" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryForm.base_fields">
 <code class="sig-name descname">base_fields</code><em class="property"> = {'db_entrytext': &lt;django.forms.fields.CharField object&gt;, 'db_help_category': &lt;django.forms.fields.CharField object&gt;, 'db_key': &lt;django.forms.fields.CharField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_staff_only': &lt;django.forms.fields.BooleanField object&gt;, 'db_tags': &lt;django.forms.models.ModelMultipleChoiceField object&gt;}</em><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.base_fields" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryForm.declared_fields">
 <code class="sig-name descname">declared_fields</code><em class="property"> = {'db_help_category': &lt;django.forms.fields.CharField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;}</em><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.declared_fields" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.help.admin.HelpEntryForm.media">
 <em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.help.admin.HelpEntryForm.media" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<dd><p>Return all media required to render the widgets on this form.</p>
+</dd></dl>

 </dd></dl>

-<dl class="class">
+<dl class="py class">
 <dt id="evennia.help.admin.HelpEntryAdmin">
-<em class="property">class </em><code class="sig-prename descclassname">evennia.help.admin.</code><code class="sig-name descname">HelpEntryAdmin</code><span class="sig-paren">(</span><em class="sig-param">model</em>, <em class="sig-param">admin_site</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpEntryAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="sig-prename descclassname">evennia.help.admin.</code><code class="sig-name descname">HelpEntryAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/admin.html#HelpEntryAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.admin.options.ModelAdmin</span></code></p>
 <p>Sets up the admin manaager for help entries</p>
-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.inlines">
 <code class="sig-name descname">inlines</code><em class="property"> = [&lt;class 'evennia.help.admin.HelpTagInline'&gt;]</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.inlines" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.list_display">
 <code class="sig-name descname">list_display</code><em class="property"> = ('id', 'db_key', 'db_help_category', 'db_lock_storage')</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.list_display" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.list_display_links">
 <code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'db_key')</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.list_display_links" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.search_fields">
 <code class="sig-name descname">search_fields</code><em class="property"> = ['^db_key', 'db_entrytext']</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.search_fields" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.ordering">
 <code class="sig-name descname">ordering</code><em class="property"> = ['db_help_category', 'db_key']</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.ordering" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.save_as">
 <code class="sig-name descname">save_as</code><em class="property"> = True</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.save_as" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.save_on_top">
 <code class="sig-name descname">save_on_top</code><em class="property"> = True</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.save_on_top" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.list_select_related">
 <code class="sig-name descname">list_select_related</code><em class="property"> = True</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.list_select_related" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.form">
 <code class="sig-name descname">form</code><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.form" title="Permalink to this definition">¶</a></dt>
 <dd><p>alias of <a class="reference internal" href="#evennia.help.admin.HelpEntryForm" title="evennia.help.admin.HelpEntryForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">HelpEntryForm</span></code></a></p>
 </dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.help.admin.HelpEntryAdmin.fieldsets">
 <code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_help_category'), 'db_entrytext', 'db_lock_storage'), 'description': 'Sets a Help entry. Set lock to &lt;i&gt;view:all()&lt;/I&gt; unless you want to restrict it.'}),)</em><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.fieldsets" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.help.admin.HelpEntryAdmin.media">
 <em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.help.admin.HelpEntryAdmin.media" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
@ -164,6 +167,7 @@
 </div>


+            <div class="clearer"></div>
          </div>
        </div>
      </div>
@ -208,12 +212,13 @@
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">evennia.help.admin</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2020, The Evennia developer community.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
    </div>
  </body>
 </html>