Skip to content

Commit 1c2d612

Browse files
Deployed c68a5b3 to latest with MkDocs 1.6.1 and mike 2.1.3
1 parent 1a996b5 commit 1c2d612

9 files changed

Lines changed: 188 additions & 208 deletions

File tree

latest/reference/API/trestle/core/commands/author/docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@
470470
<span class=k>raise</span> <span class=n>TrestleError</span><span class=p>(</span><span class=sa>f</span><span class=s1>&#39;Required template file: </span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>rel_dir</span><span class=p>(</span><span class=n>template_file</span><span class=p>)</span><span class=si>}</span><span class=s1> does not exist. Exiting.&#39;</span><span class=p>)</span>
471471
<span class=k>try</span><span class=p>:</span>
472472
<span class=n>md_api</span> <span class=o>=</span> <span class=n>MarkdownAPI</span><span class=p>()</span>
473-
<span class=n>validate_body</span> <span class=o>=</span> <span class=kc>False</span> <span class=k>if</span> <span class=n>validate_only_header</span> <span class=k>else</span> <span class=kc>True</span>
473+
<span class=n>validate_body</span> <span class=o>=</span> <span class=ow>not</span> <span class=n>validate_only_header</span>
474474
<span class=n>md_api</span><span class=o>.</span><span class=n>load_validator_with_template</span><span class=p>(</span>
475475
<span class=n>template_file</span><span class=p>,</span> <span class=n>validate_header</span> <span class=ow>or</span> <span class=n>validate_only_header</span><span class=p>,</span> <span class=n>validate_body</span><span class=p>,</span> <span class=n>heading</span><span class=p>,</span> <span class=kc>True</span>
476476
<span class=p>)</span>
@@ -738,7 +738,7 @@
738738
<span class=k>raise</span> <span class=n>TrestleError</span><span class=p>(</span><span class=sa>f</span><span class=s1>&#39;Required template file: </span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>rel_dir</span><span class=p>(</span><span class=n>template_file</span><span class=p>)</span><span class=si>}</span><span class=s1> does not exist. Exiting.&#39;</span><span class=p>)</span>
739739
<span class=k>try</span><span class=p>:</span>
740740
<span class=n>md_api</span> <span class=o>=</span> <span class=n>MarkdownAPI</span><span class=p>()</span>
741-
<span class=n>validate_body</span> <span class=o>=</span> <span class=kc>False</span> <span class=k>if</span> <span class=n>validate_only_header</span> <span class=k>else</span> <span class=kc>True</span>
741+
<span class=n>validate_body</span> <span class=o>=</span> <span class=ow>not</span> <span class=n>validate_only_header</span>
742742
<span class=n>md_api</span><span class=o>.</span><span class=n>load_validator_with_template</span><span class=p>(</span>
743743
<span class=n>template_file</span><span class=p>,</span> <span class=n>validate_header</span> <span class=ow>or</span> <span class=n>validate_only_header</span><span class=p>,</span> <span class=n>validate_body</span><span class=p>,</span> <span class=n>heading</span><span class=p>,</span> <span class=kc>True</span>
744744
<span class=p>)</span>

latest/reference/API/trestle/core/commands/author/folders/index.html

Lines changed: 14 additions & 22 deletions
Large diffs are not rendered by default.

latest/reference/API/trestle/core/commands/split/index.html

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -536,9 +536,7 @@
536536
<span class=normal>487</span>
537537
<span class=normal>488</span>
538538
<span class=normal>489</span>
539-
<span class=normal>490</span>
540-
<span class=normal>491</span>
541-
<span class=normal>492</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>class</span><span class=w> </span><span class=nc>SplitCmd</span><span class=p>(</span><span class=n>CommandPlusDocs</span><span class=p>):</span>
539+
<span class=normal>490</span></pre></div></td><td class=code><div><pre><span></span><code><span class=k>class</span><span class=w> </span><span class=nc>SplitCmd</span><span class=p>(</span><span class=n>CommandPlusDocs</span><span class=p>):</span>
542540
<span class=w> </span><span class=sd>&quot;&quot;&quot;Split subcomponents on a trestle model.&quot;&quot;&quot;</span>
543541

544542
<span class=n>name</span> <span class=o>=</span> <span class=s1>&#39;split&#39;</span>
@@ -803,9 +801,7 @@
803801
<span class=n>sub_model_items</span><span class=p>[</span><span class=n>prefix</span><span class=p>]</span> <span class=o>=</span> <span class=n>sub_model_item</span>
804802

805803
<span class=c1># process list sub model items</span>
806-
<span class=n>count</span> <span class=o>=</span> <span class=mi>0</span>
807-
<span class=k>for</span> <span class=n>key</span><span class=p>,</span> <span class=n>sub_model_item</span> <span class=ow>in</span> <span class=n>sub_model_items</span><span class=o>.</span><span class=n>items</span><span class=p>():</span>
808-
<span class=n>count</span> <span class=o>+=</span> <span class=mi>1</span>
804+
<span class=k>for</span> <span class=n>count</span><span class=p>,</span> <span class=p>(</span><span class=n>key</span><span class=p>,</span> <span class=n>sub_model_item</span><span class=p>)</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>sub_model_items</span><span class=o>.</span><span class=n>items</span><span class=p>(),</span> <span class=n>start</span><span class=o>=</span><span class=mi>1</span><span class=p>):</span>
809805
<span class=c1># recursively split the sub-model if there are more element paths to traverse</span>
810806
<span class=c1># e.g. split component.control-implementations.*</span>
811807
<span class=n>require_recursive_split</span> <span class=o>=</span> <span class=p>(</span>
@@ -962,7 +958,9 @@
962958
<span class=k>else</span><span class=p>:</span>
963959
<span class=n>tracker_map</span><span class=p>[</span><span class=n>root_path</span><span class=p>]</span> <span class=o>=</span> <span class=n>AliasTracker</span><span class=p>(</span><span class=n>aliases</span><span class=o>=</span><span class=p>[</span><span class=n>alias</span><span class=p>])</span>
964960
<span class=k>return</span> <span class=n>tracker_map</span>
965-
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> <h5 id=trestle.core.commands.split.SplitCmd-attributes>Attributes<a href=#trestle.core.commands.split.SplitCmd-attributes class=headerlink title="Permanent link">¤</a></h5> <div class="doc doc-object doc-attribute"> <h6 id=trestle.core.commands.split.SplitCmd.name class="doc doc-heading"> <code class="highlight language-python"><span class=n>name</span> <span class=o>=</span> <span class=s1>&#39;split&#39;</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#trestle.core.commands.split.SplitCmd.name class=headerlink title="Permanent link">¤</a></h6> <div class="doc doc-contents "> </div> </div> <h5 id=trestle.core.commands.split.SplitCmd-functions>Functions<a href=#trestle.core.commands.split.SplitCmd-functions class=headerlink title="Permanent link">¤</a></h5> <div class="doc doc-object doc-function"> <h6 id=trestle.core.commands.split.SplitCmd.find_aliases_to_strip class="doc doc-heading"> <code class="highlight language-python"><span class=n>find_aliases_to_strip</span><span class=p>(</span><span class=n>element_paths</span><span class=p>)</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small> </span> <a href=#trestle.core.commands.split.SplitCmd.find_aliases_to_strip class=headerlink title="Permanent link">¤</a></h6> <div class="doc doc-contents "> <p>Find list of aliases that need to be stripped as each element written out.</p> <details class=mkdocstrings-source> <summary>Source code in <code>trestle/core/commands/split.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>475</span>
961+
</code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> <h5 id=trestle.core.commands.split.SplitCmd-attributes>Attributes<a href=#trestle.core.commands.split.SplitCmd-attributes class=headerlink title="Permanent link">¤</a></h5> <div class="doc doc-object doc-attribute"> <h6 id=trestle.core.commands.split.SplitCmd.name class="doc doc-heading"> <code class="highlight language-python"><span class=n>name</span> <span class=o>=</span> <span class=s1>&#39;split&#39;</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#trestle.core.commands.split.SplitCmd.name class=headerlink title="Permanent link">¤</a></h6> <div class="doc doc-contents "> </div> </div> <h5 id=trestle.core.commands.split.SplitCmd-functions>Functions<a href=#trestle.core.commands.split.SplitCmd-functions class=headerlink title="Permanent link">¤</a></h5> <div class="doc doc-object doc-function"> <h6 id=trestle.core.commands.split.SplitCmd.find_aliases_to_strip class="doc doc-heading"> <code class="highlight language-python"><span class=n>find_aliases_to_strip</span><span class=p>(</span><span class=n>element_paths</span><span class=p>)</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small> </span> <a href=#trestle.core.commands.split.SplitCmd.find_aliases_to_strip class=headerlink title="Permanent link">¤</a></h6> <div class="doc doc-contents "> <p>Find list of aliases that need to be stripped as each element written out.</p> <details class=mkdocstrings-source> <summary>Source code in <code>trestle/core/commands/split.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>473</span>
962+
<span class=normal>474</span>
963+
<span class=normal>475</span>
966964
<span class=normal>476</span>
967965
<span class=normal>477</span>
968966
<span class=normal>478</span>
@@ -977,9 +975,7 @@
977975
<span class=normal>487</span>
978976
<span class=normal>488</span>
979977
<span class=normal>489</span>
980-
<span class=normal>490</span>
981-
<span class=normal>491</span>
982-
<span class=normal>492</span></pre></div></td><td class=code><div><pre><span></span><code><span class=nd>@classmethod</span>
978+
<span class=normal>490</span></pre></div></td><td class=code><div><pre><span></span><code><span class=nd>@classmethod</span>
983979
<span class=k>def</span><span class=w> </span><span class=nf>find_aliases_to_strip</span><span class=p>(</span><span class=bp>cls</span><span class=p>,</span> <span class=n>element_paths</span><span class=p>:</span> <span class=n>List</span><span class=p>[</span><span class=n>ElementPath</span><span class=p>])</span> <span class=o>-&gt;</span> <span class=n>Dict</span><span class=p>[</span><span class=nb>str</span><span class=p>,</span> <span class=n>AliasTracker</span><span class=p>]:</span>
984980
<span class=w> </span><span class=sd>&quot;&quot;&quot;Find list of aliases that need to be stripped as each element written out.&quot;&quot;&quot;</span>
985981
<span class=c1># A given path may be present in several split actions</span>
@@ -1215,7 +1211,9 @@
12151211
<span class=n>actions</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>CreatePathAction</span><span class=p>(</span><span class=n>sub_model_file</span><span class=p>))</span>
12161212
<span class=n>actions</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>WriteFileAction</span><span class=p>(</span><span class=n>sub_model_file</span><span class=p>,</span> <span class=n>Element</span><span class=p>(</span><span class=n>sub_model_item</span><span class=p>,</span> <span class=n>model_type</span><span class=p>),</span> <span class=n>content_type</span><span class=p>))</span>
12171213
<span class=k>return</span> <span class=n>actions</span>
1218-
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h6 id=trestle.core.commands.split.SplitCmd.split_model class="doc doc-heading"> <code class="highlight language-python"><span class=n>split_model</span><span class=p>(</span><span class=n>model_obj</span><span class=p>,</span> <span class=n>element_paths</span><span class=p>,</span> <span class=n>base_dir</span><span class=p>,</span> <span class=n>content_type</span><span class=p>,</span> <span class=n>root_file_name</span><span class=p>,</span> <span class=n>aliases_to_strip</span><span class=p>)</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small> </span> <a href=#trestle.core.commands.split.SplitCmd.split_model class=headerlink title="Permanent link">¤</a></h6> <div class="doc doc-contents "> <p>Split the model at the provided element paths.</p> <p>It returns a plan for the operation</p> <details class=mkdocstrings-source> <summary>Source code in <code>trestle/core/commands/split.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>413</span>
1214+
</code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h6 id=trestle.core.commands.split.SplitCmd.split_model class="doc doc-heading"> <code class="highlight language-python"><span class=n>split_model</span><span class=p>(</span><span class=n>model_obj</span><span class=p>,</span> <span class=n>element_paths</span><span class=p>,</span> <span class=n>base_dir</span><span class=p>,</span> <span class=n>content_type</span><span class=p>,</span> <span class=n>root_file_name</span><span class=p>,</span> <span class=n>aliases_to_strip</span><span class=p>)</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small> </span> <a href=#trestle.core.commands.split.SplitCmd.split_model class=headerlink title="Permanent link">¤</a></h6> <div class="doc doc-contents "> <p>Split the model at the provided element paths.</p> <p>It returns a plan for the operation</p> <details class=mkdocstrings-source> <summary>Source code in <code>trestle/core/commands/split.py</code></summary> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal>411</span>
1215+
<span class=normal>412</span>
1216+
<span class=normal>413</span>
12191217
<span class=normal>414</span>
12201218
<span class=normal>415</span>
12211219
<span class=normal>416</span>
@@ -1273,9 +1271,7 @@
12731271
<span class=normal>468</span>
12741272
<span class=normal>469</span>
12751273
<span class=normal>470</span>
1276-
<span class=normal>471</span>
1277-
<span class=normal>472</span>
1278-
<span class=normal>473</span></pre></div></td><td class=code><div><pre><span></span><code><span class=nd>@classmethod</span>
1274+
<span class=normal>471</span></pre></div></td><td class=code><div><pre><span></span><code><span class=nd>@classmethod</span>
12791275
<span class=k>def</span><span class=w> </span><span class=nf>split_model</span><span class=p>(</span>
12801276
<span class=bp>cls</span><span class=p>,</span>
12811277
<span class=n>model_obj</span><span class=p>:</span> <span class=n>OscalBaseModel</span><span class=p>,</span>
@@ -1528,9 +1524,7 @@
15281524
<span class=normal>406</span>
15291525
<span class=normal>407</span>
15301526
<span class=normal>408</span>
1531-
<span class=normal>409</span>
1532-
<span class=normal>410</span>
1533-
<span class=normal>411</span></pre></div></td><td class=code><div><pre><span></span><code><span class=nd>@classmethod</span>
1527+
<span class=normal>409</span></pre></div></td><td class=code><div><pre><span></span><code><span class=nd>@classmethod</span>
15341528
<span class=k>def</span><span class=w> </span><span class=nf>split_model_at_path_chain</span><span class=p>(</span>
15351529
<span class=bp>cls</span><span class=p>,</span>
15361530
<span class=n>model_obj</span><span class=p>:</span> <span class=n>OscalBaseModel</span><span class=p>,</span>
@@ -1647,9 +1641,7 @@
16471641
<span class=n>sub_model_items</span><span class=p>[</span><span class=n>prefix</span><span class=p>]</span> <span class=o>=</span> <span class=n>sub_model_item</span>
16481642

16491643
<span class=c1># process list sub model items</span>
1650-
<span class=n>count</span> <span class=o>=</span> <span class=mi>0</span>
1651-
<span class=k>for</span> <span class=n>key</span><span class=p>,</span> <span class=n>sub_model_item</span> <span class=ow>in</span> <span class=n>sub_model_items</span><span class=o>.</span><span class=n>items</span><span class=p>():</span>
1652-
<span class=n>count</span> <span class=o>+=</span> <span class=mi>1</span>
1644+
<span class=k>for</span> <span class=n>count</span><span class=p>,</span> <span class=p>(</span><span class=n>key</span><span class=p>,</span> <span class=n>sub_model_item</span><span class=p>)</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>sub_model_items</span><span class=o>.</span><span class=n>items</span><span class=p>(),</span> <span class=n>start</span><span class=o>=</span><span class=mi>1</span><span class=p>):</span>
16531645
<span class=c1># recursively split the sub-model if there are more element paths to traverse</span>
16541646
<span class=c1># e.g. split component.control-implementations.*</span>
16551647
<span class=n>require_recursive_split</span> <span class=o>=</span> <span class=p>(</span>

0 commit comments

Comments
 (0)