Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Mar 27, 2024
1 parent 653645d commit 65a12c8
Show file tree
Hide file tree
Showing 9 changed files with 6 additions and 19 deletions.
1 change: 0 additions & 1 deletion _modules/apis_core/apis_metainfo/models.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,6 @@ <h1>Source code for apis_core.apis_metainfo.models</h1><div class="highlight"><p
<span class="sd"> By having one overarching super class we gain the advantage of unique identifiers.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">deprecated_name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">verbose_name</span><span class="o">=</span><span class="s2">&quot;Name&quot;</span><span class="p">,</span> <span class="n">blank</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># self_contenttype: a foreign key to the respective contenttype comes in handy when querying for</span>
<span class="c1"># triples where the subject&#39;s or object&#39;s contenttype must be respected (e.g. get all triples</span>
<span class="c1"># where the subject is a Person)</span>
Expand Down
1 change: 0 additions & 1 deletion _modules/apis_core/apis_metainfo/test_models.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ <h1>Source code for apis_core.apis_metainfo.test_models</h1><div class="highligh
<span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="c1"># Set up data for the whole TestCase</span>
<span class="n">user_type</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</span><span class="p">(</span><span class="n">app_label</span><span class="o">=</span><span class="s2">&quot;auth&quot;</span><span class="p">,</span> <span class="n">model</span><span class="o">=</span><span class="s2">&quot;user&quot;</span><span class="p">)</span>
<span class="n">RootObject</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">self_contenttype</span><span class="o">=</span><span class="n">user_type</span><span class="p">,</span> <span class="n">deprecated_name</span><span class="o">=</span><span class="s2">&quot;foo&quot;</span><span class="p">)</span>
<span class="n">RootObject</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">self_contenttype</span><span class="o">=</span><span class="n">user_type</span><span class="p">)</span></div>


Expand Down
1 change: 0 additions & 1 deletion _modules/apis_core/apis_relations/filtersets.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ <h1>Source code for apis_core.apis_relations.filtersets</h1><div class="highligh

<span class="n">PROPERTY_EXCLUDES</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">&quot;self_contenttype&quot;</span><span class="p">,</span>
<span class="s2">&quot;deprecated_name&quot;</span><span class="p">,</span>
<span class="s2">&quot;property_class_uri&quot;</span><span class="p">,</span>
<span class="s2">&quot;rootobject_ptr&quot;</span><span class="p">,</span>
<span class="p">]</span>
Expand Down
6 changes: 2 additions & 4 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1084,6 +1084,8 @@ <h2 id="D">D</h2>
</ul></li>
<li><a href="modules/apis_core.html#apis_core.api_routers.deep_get">deep_get() (in module apis_core.api_routers)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="modules/apis_core.apis_metainfo.html#apis_core.apis_metainfo.apps.MetainfoConfig.default_auto_field">default_auto_field (apis_core.apis_metainfo.apps.MetainfoConfig attribute)</a>

<ul>
Expand All @@ -1092,8 +1094,6 @@ <h2 id="D">D</h2>
<li><a href="modules/apis_core.collections.html#apis_core.collections.apps.VocabsConfig.default_auto_field">(apis_core.collections.apps.VocabsConfig attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="modules/apis_core.utils.html#apis_core.utils.settings.default_settings">default_settings() (in module apis_core.utils.settings)</a>
</li>
<li><a href="modules/apis_core.utils.html#apis_core.utils.autocomplete.ExternalAutocompleteAdapter.default_template">default_template() (apis_core.utils.autocomplete.ExternalAutocompleteAdapter method)</a>
Expand All @@ -1111,8 +1111,6 @@ <h2 id="D">D</h2>
<li><a href="modules/apis_core.generic.html#apis_core.generic.views.Delete.delete">delete() (apis_core.generic.views.Delete method)</a>
</li>
<li><a href="modules/apis_core.generic.html#apis_core.generic.tables.DeleteColumn">DeleteColumn (class in apis_core.generic.tables)</a>
</li>
<li><a href="modules/apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.RootObject.deprecated_name">deprecated_name (apis_core.apis_metainfo.models.RootObject attribute)</a>
</li>
<li><a href="modules/apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.Collection.description">description (apis_core.apis_metainfo.models.Collection attribute)</a>

Expand Down
7 changes: 0 additions & 7 deletions modules/apis_core.apis_metainfo.html
Original file line number Diff line number Diff line change
Expand Up @@ -403,13 +403,6 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="apis_core.apis_metainfo.models.RootObject.deprecated_name">
<span class="sig-name descname"><span class="pre">deprecated_name</span></span><a class="headerlink" href="#apis_core.apis_metainfo.models.RootObject.deprecated_name" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="apis_core.apis_metainfo.models.RootObject.duplicate">
<span class="sig-name descname"><span class="pre">duplicate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_metainfo/models.html#RootObject.duplicate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_metainfo.models.RootObject.duplicate" title="Link to this definition"></a></dt>
Expand Down
6 changes: 3 additions & 3 deletions modules/apis_core.apis_relations.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apis_core.apis_relations.filtersets.PropertyFilterSet.Meta.exclude">
<span class="sig-name descname"><span class="pre">exclude</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['self_contenttype',</span> <span class="pre">'deprecated_name',</span> <span class="pre">'property_class_uri',</span> <span class="pre">'rootobject_ptr']</span></em><a class="headerlink" href="#apis_core.apis_relations.filtersets.PropertyFilterSet.Meta.exclude" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">exclude</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['self_contenttype',</span> <span class="pre">'property_class_uri',</span> <span class="pre">'rootobject_ptr']</span></em><a class="headerlink" href="#apis_core.apis_relations.filtersets.PropertyFilterSet.Meta.exclude" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
Expand Down Expand Up @@ -183,7 +183,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

<dl class="py attribute">
<dt class="sig sig-object py" id="apis_core.apis_relations.filtersets.PropertyFilterSetForm.columns_exclude">
<span class="sig-name descname"><span class="pre">columns_exclude</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['self_contenttype',</span> <span class="pre">'deprecated_name',</span> <span class="pre">'property_class_uri',</span> <span class="pre">'rootobject_ptr']</span></em><a class="headerlink" href="#apis_core.apis_relations.filtersets.PropertyFilterSetForm.columns_exclude" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">columns_exclude</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['self_contenttype',</span> <span class="pre">'property_class_uri',</span> <span class="pre">'rootobject_ptr']</span></em><a class="headerlink" href="#apis_core.apis_relations.filtersets.PropertyFilterSetForm.columns_exclude" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
Expand Down Expand Up @@ -374,7 +374,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

<dl class="py class">
<dt class="sig sig-object py" id="apis_core.apis_relations.models.Property">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apis_core.apis_relations.models.</span></span><span class="sig-name descname"><span class="pre">Property</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deprecated_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">self_contenttype</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rootobject_ptr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">property_class_uri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_forward</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_reverse</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_relations/models.html#Property"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_relations.models.Property" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apis_core.apis_relations.models.</span></span><span class="sig-name descname"><span class="pre">Property</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">self_contenttype</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rootobject_ptr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">property_class_uri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_forward</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_reverse</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_relations/models.html#Property"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_relations.models.Property" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.RootObject" title="apis_core.apis_metainfo.models.RootObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">RootObject</span></code></a></p>
<dl class="py exception">
<dt class="sig sig-object py" id="apis_core.apis_relations.models.Property.DoesNotExist">
Expand Down
1 change: 0 additions & 1 deletion modules/apis_core.html
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,6 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l3"><a class="reference internal" href="apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.RootObject"><code class="docutils literal notranslate"><span class="pre">RootObject</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.RootObject.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">RootObject.DoesNotExist</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.RootObject.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">RootObject.MultipleObjectsReturned</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.RootObject.deprecated_name"><code class="docutils literal notranslate"><span class="pre">RootObject.deprecated_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.RootObject.duplicate"><code class="docutils literal notranslate"><span class="pre">RootObject.duplicate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.RootObject.id"><code class="docutils literal notranslate"><span class="pre">RootObject.id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_metainfo.html#apis_core.apis_metainfo.models.RootObject.objects"><code class="docutils literal notranslate"><span class="pre">RootObject.objects</span></code></a></li>
Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 65a12c8

Please sign in to comment.