Updated documentation

acdh-oeaw · Apr 8, 2024 · 9a90abc · 9a90abc
1 parent 32ac30c
commit 9a90abc
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 3 deletions.
diff --git a/_modules/apis_core/apis_entities/models.html b/_modules/apis_core/apis_entities/models.html
@@ -212,6 +212,16 @@ <h1>Source code for apis_core.apis_entities.models</h1><div class="highlight"><p
         <span class="p">)</span></div>
 
 
+<div class="viewcode-block" id="AbstractEntity.get_merge_url">
+<a class="viewcode-back" href="../../../modules/apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_merge_url">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_merge_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="n">entity</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
+        <span class="k">return</span> <span class="n">reverse</span><span class="p">(</span>
+            <span class="s2">&quot;apis_core:apis_entities:generic_entities_merge_view&quot;</span><span class="p">,</span>
+            <span class="n">kwargs</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;contenttype&quot;</span><span class="p">:</span> <span class="n">entity</span><span class="p">,</span> <span class="s2">&quot;pk&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">},</span>
+        <span class="p">)</span></div>
+
+
 <div class="viewcode-block" id="AbstractEntity.merge_charfield">
 <a class="viewcode-back" href="../../../modules/apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.merge_charfield">[docs]</a>
     <span class="k">def</span> <span class="nf">merge_charfield</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">,</span> <span class="n">field</span><span class="p">):</span>

diff --git a/_modules/apis_core/generic/abc.html b/_modules/apis_core/generic/abc.html
@@ -92,6 +92,7 @@
   <h1>Source code for apis_core.generic.abc</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">django.urls</span> <span class="kn">import</span> <span class="n">reverse</span>
 <span class="kn">from</span> <span class="nn">django.contrib.contenttypes.models</span> <span class="kn">import</span> <span class="n">ContentType</span>
+<span class="kn">from</span> <span class="nn">apis_core.generic.helpers</span> <span class="kn">import</span> <span class="n">permission_fullname</span>
 
 
 <div class="viewcode-block" id="GenericModel">
@@ -132,6 +133,27 @@ <h1>Source code for apis_core.generic.abc</h1><div class="highlight"><pre>
     <span class="k">def</span> <span class="nf">get_delete_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="n">ct</span> <span class="o">=</span> <span class="n">ContentType</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get_for_model</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">reverse</span><span class="p">(</span><span class="s2">&quot;apis_core:generic:delete&quot;</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="n">ct</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">])</span></div>
+
+
+<div class="viewcode-block" id="GenericModel.get_change_permission">
+<a class="viewcode-back" href="../../../modules/apis_core.generic.html#apis_core.generic.abc.GenericModel.get_change_permission">[docs]</a>
+    <span class="nd">@classmethod</span>
+    <span class="k">def</span> <span class="nf">get_change_permission</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="n">permission_fullname</span><span class="p">(</span><span class="s2">&quot;change&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="GenericModel.get_add_permission">
+<a class="viewcode-back" href="../../../modules/apis_core.generic.html#apis_core.generic.abc.GenericModel.get_add_permission">[docs]</a>
+    <span class="nd">@classmethod</span>
+    <span class="k">def</span> <span class="nf">get_add_permission</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="n">permission_fullname</span><span class="p">(</span><span class="s2">&quot;add&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="GenericModel.get_delete_permission">
+<a class="viewcode-back" href="../../../modules/apis_core.generic.html#apis_core.generic.abc.GenericModel.get_delete_permission">[docs]</a>
+    <span class="nd">@classmethod</span>
+    <span class="k">def</span> <span class="nf">get_delete_permission</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="n">permission_fullname</span><span class="p">(</span><span class="s2">&quot;delete&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span></div>
 </div>
 
 </pre></div>

diff --git a/genindex.html b/genindex.html
@@ -1551,6 +1551,8 @@ <h2 id="G">G</h2>
       <li><a href="modules/apis_core.generic.html#apis_core.generic.abc.GenericModel.get_absolute_url">get_absolute_url() (apis_core.generic.abc.GenericModel method)</a>
 </li>
       <li><a href="modules/apis_core.history.html#apis_core.history.serializers.HistoryLogSerializer.get_action">get_action() (apis_core.history.serializers.HistoryLogSerializer method)</a>
+</li>
+      <li><a href="modules/apis_core.generic.html#apis_core.generic.abc.GenericModel.get_add_permission">get_add_permission() (apis_core.generic.abc.GenericModel class method)</a>
 </li>
       <li><a href="modules/apis_core.utils.html#apis_core.utils.caching.get_all_class_modules_and_names">get_all_class_modules_and_names() (in module apis_core.utils.caching)</a>
 </li>
@@ -1567,6 +1569,8 @@ <h2 id="G">G</h2>
       <li><a href="modules/apis_core.generic.html#apis_core.generic.generators.CustomEndpointEnumerator.get_api_endpoints">get_api_endpoints() (apis_core.generic.generators.CustomEndpointEnumerator method)</a>
 </li>
       <li><a href="modules/apis_core.utils.html#apis_core.utils.caching.get_autocomplete_property_choices">get_autocomplete_property_choices() (in module apis_core.utils.caching)</a>
+</li>
+      <li><a href="modules/apis_core.generic.html#apis_core.generic.abc.GenericModel.get_change_permission">get_change_permission() (apis_core.generic.abc.GenericModel class method)</a>
 </li>
       <li><a href="modules/apis_core.utils.html#apis_core.utils.utils.get_child_classes">get_child_classes() (in module apis_core.utils.utils)</a>
 </li>
@@ -1599,6 +1603,8 @@ <h2 id="G">G</h2>
       <li><a href="modules/apis_core.apis_relations.html#apis_core.apis_relations.models.VersionTempTriple.get_default_history_user">get_default_history_user() (apis_core.apis_relations.models.VersionTempTriple static method)</a>
 </li>
       <li><a href="modules/apis_core.utils.html#apis_core.utils.rdf.get_definition_and_attributes_from_uri">get_definition_and_attributes_from_uri() (in module apis_core.utils.rdf)</a>
+</li>
+      <li><a href="modules/apis_core.generic.html#apis_core.generic.abc.GenericModel.get_delete_permission">get_delete_permission() (apis_core.generic.abc.GenericModel class method)</a>
 </li>
       <li><a href="modules/apis_core.generic.html#apis_core.generic.abc.GenericModel.get_delete_url">get_delete_url() (apis_core.generic.abc.GenericModel method)</a>
 </li>
@@ -1613,11 +1619,11 @@ <h2 id="G">G</h2>
 </li>
       </ul></li>
       <li><a href="modules/apis_core.utils.html#apis_core.utils.caching.get_entity_class_of_name">get_entity_class_of_name() (in module apis_core.utils.caching)</a>
-</li>
-      <li><a href="modules/apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_entity_list_filter">get_entity_list_filter() (apis_core.apis_entities.models.AbstractEntity class method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="modules/apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_entity_list_filter">get_entity_list_filter() (apis_core.apis_entities.models.AbstractEntity class method)</a>
+</li>
       <li><a href="modules/apis_core.utils.html#apis_core.utils.settings.get_entity_settings_by_modelname">get_entity_settings_by_modelname() (in module apis_core.utils.settings)</a>
 </li>
       <li><a href="modules/apis_core.history.html#apis_core.history.serializers.ModelChangeSerializer.get_field_data">get_field_data() (apis_core.history.serializers.ModelChangeSerializer method)</a>
@@ -1663,6 +1669,8 @@ <h2 id="G">G</h2>
       <li><a href="modules/apis_core.history.html#apis_core.history.models.APISHistoricalRecords.get_m2m_fields_from_model">get_m2m_fields_from_model() (apis_core.history.models.APISHistoricalRecords method)</a>
 </li>
       <li><a href="modules/apis_core.utils.html#apis_core.utils.helpers.get_member_for_entity">get_member_for_entity() (in module apis_core.utils.helpers)</a>
+</li>
+      <li><a href="modules/apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_merge_url">get_merge_url() (apis_core.apis_entities.models.AbstractEntity method)</a>
 </li>
       <li><a href="modules/apis_core.utils.html#apis_core.utils.utils.get_module_path">get_module_path() (in module apis_core.utils.utils)</a>
 </li>

diff --git a/modules/apis_core.apis_entities.html b/modules/apis_core.apis_entities.html
@@ -638,6 +638,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_entity_list_filter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_entities/models.html#AbstractEntity.get_entity_list_filter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_entities.models.AbstractEntity.get_entity_list_filter" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="apis_core.apis_entities.models.AbstractEntity.get_merge_url">
+<span class="sig-name descname"><span class="pre">get_merge_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_entities/models.html#AbstractEntity.get_merge_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_entities.models.AbstractEntity.get_merge_url" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="apis_core.apis_entities.models.AbstractEntity.get_next_url">
 <span class="sig-name descname"><span class="pre">get_next_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_entities/models.html#AbstractEntity.get_next_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_entities.models.AbstractEntity.get_next_url" title="Link to this definition"></a></dt>

diff --git a/modules/apis_core.generic.html b/modules/apis_core.generic.html
@@ -173,11 +173,26 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <span class="sig-name descname"><span class="pre">get_absolute_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/generic/abc.html#GenericModel.get_absolute_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.generic.abc.GenericModel.get_absolute_url" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="apis_core.generic.abc.GenericModel.get_add_permission">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_add_permission</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/generic/abc.html#GenericModel.get_add_permission"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.generic.abc.GenericModel.get_add_permission" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="apis_core.generic.abc.GenericModel.get_change_permission">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_change_permission</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/generic/abc.html#GenericModel.get_change_permission"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.generic.abc.GenericModel.get_change_permission" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="apis_core.generic.abc.GenericModel.get_createview_url">
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_createview_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/generic/abc.html#GenericModel.get_createview_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.generic.abc.GenericModel.get_createview_url" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="apis_core.generic.abc.GenericModel.get_delete_permission">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_delete_permission</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/generic/abc.html#GenericModel.get_delete_permission"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.generic.abc.GenericModel.get_delete_permission" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="apis_core.generic.abc.GenericModel.get_delete_url">
 <span class="sig-name descname"><span class="pre">get_delete_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/generic/abc.html#GenericModel.get_delete_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.generic.abc.GenericModel.get_delete_url" title="Link to this definition"></a></dt>

diff --git a/modules/apis_core.html b/modules/apis_core.html
@@ -245,6 +245,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_duplicate_url"><code class="docutils literal notranslate"><span class="pre">AbstractEntity.get_duplicate_url()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_edit_url"><code class="docutils literal notranslate"><span class="pre">AbstractEntity.get_edit_url()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_entity_list_filter"><code class="docutils literal notranslate"><span class="pre">AbstractEntity.get_entity_list_filter()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_merge_url"><code class="docutils literal notranslate"><span class="pre">AbstractEntity.get_merge_url()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_next_url"><code class="docutils literal notranslate"><span class="pre">AbstractEntity.get_next_url()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_or_create_uri"><code class="docutils literal notranslate"><span class="pre">AbstractEntity.get_or_create_uri()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.models.AbstractEntity.get_prev_url"><code class="docutils literal notranslate"><span class="pre">AbstractEntity.get_prev_url()</span></code></a></li>
@@ -877,7 +878,10 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l2"><a class="reference internal" href="apis_core.generic.html#module-apis_core.generic.abc">apis_core.generic.abc module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="apis_core.generic.html#apis_core.generic.abc.GenericModel"><code class="docutils literal notranslate"><span class="pre">GenericModel</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.generic.html#apis_core.generic.abc.GenericModel.get_absolute_url"><code class="docutils literal notranslate"><span class="pre">GenericModel.get_absolute_url()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="apis_core.generic.html#apis_core.generic.abc.GenericModel.get_add_permission"><code class="docutils literal notranslate"><span class="pre">GenericModel.get_add_permission()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="apis_core.generic.html#apis_core.generic.abc.GenericModel.get_change_permission"><code class="docutils literal notranslate"><span class="pre">GenericModel.get_change_permission()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.generic.html#apis_core.generic.abc.GenericModel.get_createview_url"><code class="docutils literal notranslate"><span class="pre">GenericModel.get_createview_url()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="apis_core.generic.html#apis_core.generic.abc.GenericModel.get_delete_permission"><code class="docutils literal notranslate"><span class="pre">GenericModel.get_delete_permission()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.generic.html#apis_core.generic.abc.GenericModel.get_delete_url"><code class="docutils literal notranslate"><span class="pre">GenericModel.get_delete_url()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.generic.html#apis_core.generic.abc.GenericModel.get_edit_url"><code class="docutils literal notranslate"><span class="pre">GenericModel.get_edit_url()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="apis_core.generic.html#apis_core.generic.abc.GenericModel.get_listview_url"><code class="docutils literal notranslate"><span class="pre">GenericModel.get_listview_url()</span></code></a></li>

diff --git a/objects.inv b/objects.inv
diff --git a/searchindex.js b/searchindex.js