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 22, 2024
1 parent 1f73fd3 commit 804e9cf
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 32 deletions.
10 changes: 6 additions & 4 deletions _modules/apis_core/apis_entities/abc.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@

<h1>Source code for apis_core.apis_entities.abc</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">django.db</span> <span class="kn">import</span> <span class="n">models</span>
<span class="kn">from</span> <span class="nn">apis_core.core.abc</span> <span class="kn">import</span> <span class="n">LabelBaseModel</span>

<span class="c1">#########################</span>
<span class="c1"># Abstract base classes #</span>
Expand All @@ -104,7 +103,7 @@ <h1>Source code for apis_core.apis_entities.abc</h1><div class="highlight"><pre>

<div class="viewcode-block" id="E21_Person">
<a class="viewcode-back" href="../../../modules/apis_core.apis_entities.html#apis_core.apis_entities.abc.E21_Person">[docs]</a>
<span class="k">class</span> <span class="nc">E21_Person</span><span class="p">(</span><span class="n">LabelBaseModel</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="k">class</span> <span class="nc">E21_Person</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">forename</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">blank</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="n">surname</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">blank</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="n">gender</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">blank</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
Expand All @@ -121,7 +120,8 @@ <h1>Source code for apis_core.apis_entities.abc</h1><div class="highlight"><pre>

<div class="viewcode-block" id="E53_Place">
<a class="viewcode-back" href="../../../modules/apis_core.apis_entities.html#apis_core.apis_entities.abc.E53_Place">[docs]</a>
<span class="k">class</span> <span class="nc">E53_Place</span><span class="p">(</span><span class="n">LabelBaseModel</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="k">class</span> <span class="nc">E53_Place</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">label</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">blank</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="n">longitude</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">FloatField</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="n">null</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">latitude</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">FloatField</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="n">null</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

Expand All @@ -135,7 +135,9 @@ <h1>Source code for apis_core.apis_entities.abc</h1><div class="highlight"><pre>

<div class="viewcode-block" id="E74_Group">
<a class="viewcode-back" href="../../../modules/apis_core.apis_entities.html#apis_core.apis_entities.abc.E74_Group">[docs]</a>
<span class="k">class</span> <span class="nc">E74_Group</span><span class="p">(</span><span class="n">LabelBaseModel</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="k">class</span> <span class="nc">E74_Group</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="n">label</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">blank</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>

<div class="viewcode-block" id="E74_Group.Meta">
<a class="viewcode-back" href="../../../modules/apis_core.apis_entities.html#apis_core.apis_entities.abc.E74_Group.Meta">[docs]</a>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
Expand Down
10 changes: 3 additions & 7 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1682,16 +1682,12 @@ <h2 id="L">L</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="glossary.html#term-Label"><strong>Label</strong></a>
</li>
<li><a href="modules/apis_core.apis_entities.html#apis_core.apis_entities.abc.E21_Person.label">label (apis_core.apis_entities.abc.E21_Person attribute)</a>
<li><a href="modules/apis_core.apis_entities.html#apis_core.apis_entities.abc.E53_Place.label">label (apis_core.apis_entities.abc.E53_Place attribute)</a>

<ul>
<li><a href="modules/apis_core.apis_entities.html#apis_core.apis_entities.abc.E53_Place.label">(apis_core.apis_entities.abc.E53_Place attribute)</a>
</li>
<li><a href="modules/apis_core.apis_entities.html#apis_core.apis_entities.abc.E74_Group.label">(apis_core.apis_entities.abc.E74_Group attribute)</a>
</li>
<li><a href="modules/apis_core.utils.html#apis_core.utils.test_rdf.Institution.label">(apis_core.utils.test_rdf.Institution attribute)</a>
</li>
<li><a href="modules/apis_core.utils.html#apis_core.utils.test_rdf.Person.label">(apis_core.utils.test_rdf.Person attribute)</a>
</li>
<li><a href="modules/apis_core.utils.html#apis_core.utils.test_rdf.Place.label">(apis_core.utils.test_rdf.Place attribute)</a>
</li>
Expand All @@ -1708,10 +1704,10 @@ <h2 id="L">L</h2>
<li><a href="modules/apis_core.utils.html#apis_core.utils.test_rdf.Place.latitude">(apis_core.utils.test_rdf.Place attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="modules/apis_core.generic.html#apis_core.generic.views.List">List (class in apis_core.generic.views)</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.viewsets.UriToObjectViewSet.list">list() (apis_core.apis_metainfo.viewsets.UriToObjectViewSet method)</a>
</li>
<li><a href="modules/apis_core.utils.html#apis_core.utils.settings.list_links_to_edit">list_links_to_edit() (in module apis_core.utils.settings)</a>
Expand Down
13 changes: 3 additions & 10 deletions modules/apis_core.apis_entities.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,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_entities.abc.E21_Person">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apis_core.apis_entities.abc.</span></span><span class="sig-name descname"><span class="pre">E21_Person</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_entities/abc.html#E21_Person"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_entities.abc.E21_Person" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">LabelBaseModel</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></p>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></p>
<dl class="py class">
<dt class="sig sig-object py" id="apis_core.apis_entities.abc.E21_Person.Meta">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/apis_core/apis_entities/abc.html#E21_Person.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_entities.abc.E21_Person.Meta" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -144,13 +144,6 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
object the first time, the query is executed.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="apis_core.apis_entities.abc.E21_Person.label">
<span class="sig-name descname"><span class="pre">label</span></span><a class="headerlink" href="#apis_core.apis_entities.abc.E21_Person.label" 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 attribute">
<dt class="sig sig-object py" id="apis_core.apis_entities.abc.E21_Person.surname">
<span class="sig-name descname"><span class="pre">surname</span></span><a class="headerlink" href="#apis_core.apis_entities.abc.E21_Person.surname" title="Link to this definition"></a></dt>
Expand All @@ -163,7 +156,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_entities.abc.E53_Place">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apis_core.apis_entities.abc.</span></span><span class="sig-name descname"><span class="pre">E53_Place</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_entities/abc.html#E53_Place"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_entities.abc.E53_Place" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">LabelBaseModel</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></p>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></p>
<dl class="py class">
<dt class="sig sig-object py" id="apis_core.apis_entities.abc.E53_Place.Meta">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/apis_core/apis_entities/abc.html#E53_Place.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_entities.abc.E53_Place.Meta" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -201,7 +194,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_entities.abc.E74_Group">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apis_core.apis_entities.abc.</span></span><span class="sig-name descname"><span class="pre">E74_Group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_entities/abc.html#E74_Group"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_entities.abc.E74_Group" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">LabelBaseModel</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></p>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></p>
<dl class="py class">
<dt class="sig sig-object py" id="apis_core.apis_entities.abc.E74_Group.Meta">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/apis_core/apis_entities/abc.html#E74_Group.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_entities.abc.E74_Group.Meta" title="Link to this definition"></a></dt>
Expand Down
2 changes: 0 additions & 2 deletions modules/apis_core.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ <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.abc.E21_Person.date_of_death"><code class="docutils literal notranslate"><span class="pre">E21_Person.date_of_death</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.abc.E21_Person.forename"><code class="docutils literal notranslate"><span class="pre">E21_Person.forename</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.abc.E21_Person.gender"><code class="docutils literal notranslate"><span class="pre">E21_Person.gender</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.abc.E21_Person.label"><code class="docutils literal notranslate"><span class="pre">E21_Person.label</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.apis_entities.html#apis_core.apis_entities.abc.E21_Person.surname"><code class="docutils literal notranslate"><span class="pre">E21_Person.surname</span></code></a></li>
</ul>
</li>
Expand Down Expand Up @@ -1153,7 +1152,6 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal" href="apis_core.utils.html#apis_core.utils.test_rdf.Person.forename"><code class="docutils literal notranslate"><span class="pre">Person.forename</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.utils.html#apis_core.utils.test_rdf.Person.gender"><code class="docutils literal notranslate"><span class="pre">Person.gender</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.utils.html#apis_core.utils.test_rdf.Person.id"><code class="docutils literal notranslate"><span class="pre">Person.id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.utils.html#apis_core.utils.test_rdf.Person.label"><code class="docutils literal notranslate"><span class="pre">Person.label</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.utils.html#apis_core.utils.test_rdf.Person.objects"><code class="docutils literal notranslate"><span class="pre">Person.objects</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="apis_core.utils.html#apis_core.utils.test_rdf.Person.surname"><code class="docutils literal notranslate"><span class="pre">Person.surname</span></code></a></li>
</ul>
Expand Down
Loading

0 comments on commit 804e9cf

Please sign in to comment.