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 cd00263 commit a7a74f9
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 20 deletions.
20 changes: 5 additions & 15 deletions _modules/apis_core/apis_relations/tables.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,10 @@ <h1>Source code for apis_core.apis_relations.tables</h1><div class="highlight"><

<div class="viewcode-block" id="TripleTable.Meta">
<a class="viewcode-back" href="../../../modules/apis_core.apis_relations.html#apis_core.apis_relations.tables.TripleTable.Meta">[docs]</a>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">(</span><span class="n">GenericTable</span><span class="o">.</span><span class="n">Meta</span><span class="p">):</span>
<span class="n">fields</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;id&quot;</span><span class="p">,</span> <span class="s2">&quot;subj&quot;</span><span class="p">,</span> <span class="s2">&quot;prop&quot;</span><span class="p">,</span> <span class="s2">&quot;obj&quot;</span><span class="p">]</span>
<span class="n">exclude</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;desc&quot;</span><span class="p">]</span>
<span class="n">sequence</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;id&quot;</span><span class="p">,</span> <span class="s2">&quot;subj&quot;</span><span class="p">,</span> <span class="s2">&quot;prop&quot;</span><span class="p">,</span> <span class="s2">&quot;obj&quot;</span><span class="p">,</span> <span class="s2">&quot;...&quot;</span><span class="p">)</span></div>
<span class="n">sequence</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">fields</span><span class="p">)</span> <span class="o">+</span> <span class="n">GenericTable</span><span class="o">.</span><span class="n">Meta</span><span class="o">.</span><span class="n">sequence</span></div>
</div>


Expand Down Expand Up @@ -167,22 +167,12 @@ <h1>Source code for apis_core.apis_relations.tables</h1><div class="highlight"><

<div class="viewcode-block" id="PropertyTable.Meta">
<a class="viewcode-back" href="../../../modules/apis_core.apis_relations.html#apis_core.apis_relations.tables.PropertyTable.Meta">[docs]</a>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
<span class="k">class</span> <span class="nc">Meta</span><span class="p">(</span><span class="n">GenericTable</span><span class="o">.</span><span class="n">Meta</span><span class="p">):</span>
<span class="n">fields</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;subject&quot;</span><span class="p">,</span> <span class="s2">&quot;predicate&quot;</span><span class="p">,</span> <span class="s2">&quot;object&quot;</span><span class="p">,</span> <span class="s2">&quot;predicate_reverse&quot;</span><span class="p">]</span>
<span class="n">order_by</span> <span class="o">=</span> <span class="s2">&quot;predicate&quot;</span>
<span class="n">exclude</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;desc&quot;</span><span class="p">]</span></div>

<span class="n">exclude</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;desc&quot;</span><span class="p">]</span>
<span class="n">sequence</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">fields</span><span class="p">)</span> <span class="o">+</span> <span class="n">GenericTable</span><span class="o">.</span><span class="n">Meta</span><span class="o">.</span><span class="n">sequence</span></div>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="s2">&quot;sequence&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;sequence&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">&quot;subject&quot;</span><span class="p">,</span>
<span class="s2">&quot;predicate&quot;</span><span class="p">,</span>
<span class="s2">&quot;object&quot;</span><span class="p">,</span>
<span class="s2">&quot;predicate_reverse&quot;</span><span class="p">,</span>
<span class="s2">&quot;...&quot;</span><span class="p">,</span>
<span class="p">]</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>

<span class="c1"># Use order_ methods to define how individual columns should be sorted.</span>
<span class="c1"># Method names are column names prefixed with &quot;order_&quot;.</span>
Expand Down
2 changes: 2 additions & 0 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -2314,6 +2314,8 @@ <h2 id="S">S</h2>
<li><a href="modules/apis_core.apis_entities.html#apis_core.apis_entities.tables.AbstractEntityTable.Meta.sequence">sequence (apis_core.apis_entities.tables.AbstractEntityTable.Meta attribute)</a>

<ul>
<li><a href="modules/apis_core.apis_relations.html#apis_core.apis_relations.tables.PropertyTable.Meta.sequence">(apis_core.apis_relations.tables.PropertyTable.Meta attribute)</a>
</li>
<li><a href="modules/apis_core.apis_relations.html#apis_core.apis_relations.tables.TripleTable.Meta.sequence">(apis_core.apis_relations.tables.TripleTable.Meta attribute)</a>
</li>
<li><a href="modules/apis_core.generic.html#apis_core.generic.tables.GenericTable.Meta.sequence">(apis_core.generic.tables.GenericTable.Meta attribute)</a>
Expand Down
13 changes: 9 additions & 4 deletions modules/apis_core.apis_relations.html
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<span id="apis-core-apis-relations-tables-module"></span><h2>apis_core.apis_relations.tables module<a class="headerlink" href="#module-apis_core.apis_relations.tables" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="apis_core.apis_relations.tables.PropertyTable">
<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.tables.</span></span><span class="sig-name descname"><span class="pre">PropertyTable</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_relations/tables.html#PropertyTable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_relations.tables.PropertyTable" 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.tables.</span></span><span class="sig-name descname"><span class="pre">PropertyTable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order_by</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orderable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">row_attrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pinned_row_attrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sequence</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order_by_field</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_field</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">per_page_field</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_header</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_footer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_columns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/apis_core/apis_relations/tables.html#PropertyTable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_relations.tables.PropertyTable" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apis_core.generic.html#apis_core.generic.tables.GenericTable" title="apis_core.generic.tables.GenericTable"><code class="xref py py-class docutils literal notranslate"><span class="pre">GenericTable</span></code></a></p>
<p>Construct table for properties.</p>
<p>The table shows how entities connect with one another via properties (relations).
Expand All @@ -781,7 +781,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.tables.PropertyTable.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_relations/tables.html#PropertyTable.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_relations.tables.PropertyTable.Meta" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dd><p>Bases: <a class="reference internal" href="apis_core.generic.html#apis_core.generic.tables.GenericTable.Meta" title="apis_core.generic.tables.GenericTable.Meta"><code class="xref py py-class docutils literal notranslate"><span class="pre">Meta</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apis_core.apis_relations.tables.PropertyTable.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">['desc']</span></em><a class="headerlink" href="#apis_core.apis_relations.tables.PropertyTable.Meta.exclude" title="Link to this definition"></a></dt>
Expand All @@ -797,6 +797,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<span class="sig-name descname"><span class="pre">order_by</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'predicate'</span></em><a class="headerlink" href="#apis_core.apis_relations.tables.PropertyTable.Meta.order_by" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="apis_core.apis_relations.tables.PropertyTable.Meta.sequence">
<span class="sig-name descname"><span class="pre">sequence</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('subject',</span> <span class="pre">'predicate',</span> <span class="pre">'object',</span> <span class="pre">'predicate_reverse',</span> <span class="pre">'...',</span> <span class="pre">'view',</span> <span class="pre">'edit',</span> <span class="pre">'delete')</span></em><a class="headerlink" href="#apis_core.apis_relations.tables.PropertyTable.Meta.sequence" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py attribute">
Expand Down Expand Up @@ -829,7 +834,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.tables.TripleTable.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_relations/tables.html#TripleTable.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apis_core.apis_relations.tables.TripleTable.Meta" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dd><p>Bases: <a class="reference internal" href="apis_core.generic.html#apis_core.generic.tables.GenericTable.Meta" title="apis_core.generic.tables.GenericTable.Meta"><code class="xref py py-class docutils literal notranslate"><span class="pre">Meta</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apis_core.apis_relations.tables.TripleTable.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">['desc']</span></em><a class="headerlink" href="#apis_core.apis_relations.tables.TripleTable.Meta.exclude" title="Link to this definition"></a></dt>
Expand All @@ -842,7 +847,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.tables.TripleTable.Meta.sequence">
<span class="sig-name descname"><span class="pre">sequence</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('id',</span> <span class="pre">'subj',</span> <span class="pre">'prop',</span> <span class="pre">'obj',</span> <span class="pre">'...')</span></em><a class="headerlink" href="#apis_core.apis_relations.tables.TripleTable.Meta.sequence" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">sequence</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('id',</span> <span class="pre">'subj',</span> <span class="pre">'prop',</span> <span class="pre">'obj',</span> <span class="pre">'...',</span> <span class="pre">'view',</span> <span class="pre">'edit',</span> <span class="pre">'delete')</span></em><a class="headerlink" href="#apis_core.apis_relations.tables.TripleTable.Meta.sequence" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>
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 a7a74f9

Please sign in to comment.