Skip to content

Commit

Permalink
Deploying Updated Jazzy Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@marzvrover
marzvrover committed Sep 6, 2024
1 parent 72b692a commit f0be7ac
Show file tree
Hide file tree
Showing 26 changed files with 108 additions and 84 deletions.
6 changes: 3 additions & 3 deletions docs/main/Protocols.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Heap Reference</a>
<a class="breadcrumb" href="index.html">Heap</a>
<img class="carat" src="img/carat.png" alt=""/>
Protocols Reference
</p>
Expand Down Expand Up @@ -138,8 +138,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
16 changes: 9 additions & 7 deletions docs/main/Protocols/Heap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Heap Reference</a>
<a class="breadcrumb" href="../index.html">Heap</a>
<img class="carat" src="../img/carat.png" alt=""/>
<a class="breadcrumb" href="../Protocols.html">Protocols</a>
<img class="carat" src="../img/carat.png" alt=""/>
Heap Protocol Reference
</p>
Expand Down Expand Up @@ -334,7 +336,7 @@ <h4>Declaration</h4>
</div>
<div>
<h4>Return Value</h4>
<p>The next item of type <code><a href="../Protocols/Heap.html#/s:4HeapAAP11ElementTypeQa">ElementType</a></code> from the <code>Heap</code> or, if the <code>Heap</code>.<code>isEmpty</code> return&rsquo;s <code>nil</code>.</p>
<p>The next item of type <code><a href="../Protocols/Heap.html#/s:4HeapAAP11ElementTypeQa">ElementType</a></code> from the <code>Heap</code> or, if the <code><a href="../Protocols/Heap.html#/s:4HeapAAP7isEmptySbvp">code&gt;.&lt;code&gt;isEmpty</a></code> return&rsquo;s <code>nil</code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/swiftpackages/Heap/tree/main/Sources/Heap/Heap.swift#L31-L36">Show on GitHub</a>
Expand Down Expand Up @@ -371,7 +373,7 @@ <h4>Declaration</h4>
</div>
<div>
<h4>Return Value</h4>
<p>The next item of type <code><a href="../Protocols/Heap.html#/s:4HeapAAP11ElementTypeQa">ElementType</a></code> from the <code>Heap</code> or, if the <code>Heap</code>.<code>isEmpty</code> return&rsquo;s <code>nil</code>.</p>
<p>The next item of type <code><a href="../Protocols/Heap.html#/s:4HeapAAP11ElementTypeQa">ElementType</a></code> from the <code>Heap</code> or, if the <code><a href="../Protocols/Heap.html#/s:4HeapAAP7isEmptySbvp">code&gt;.&lt;code&gt;isEmpty</a></code> return&rsquo;s <code>nil</code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/swiftpackages/Heap/tree/main/Sources/Heap/Heap.swift#L40-L51">Show on GitHub</a>
Expand Down Expand Up @@ -619,7 +621,7 @@ <h4>Parameters</h4>
</td>
<td>
<div>
<p>the parent index</p>
<p>the child index</p>
</div>
</td>
</tr>
Expand All @@ -628,7 +630,7 @@ <h4>Parameters</h4>
</div>
<div>
<h4>Return Value</h4>
<p>right child index</p>
<p>the parent index</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/swiftpackages/Heap/tree/main/Sources/Heap/Heap.swift#L87-L89">Show on GitHub</a>
Expand Down Expand Up @@ -1044,8 +1046,8 @@ <h4>Parameters</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
6 changes: 3 additions & 3 deletions docs/main/Structs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Heap Reference</a>
<a class="breadcrumb" href="index.html">Heap</a>
<img class="carat" src="img/carat.png" alt=""/>
Structures Reference
</p>
Expand Down Expand Up @@ -302,8 +302,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
10 changes: 6 additions & 4 deletions docs/main/Structs/HeapIterator.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Heap Reference</a>
<a class="breadcrumb" href="../index.html">Heap</a>
<img class="carat" src="../img/carat.png" alt=""/>
<a class="breadcrumb" href="../Structs.html">Structures</a>
<img class="carat" src="../img/carat.png" alt=""/>
HeapIterator Structure Reference
</p>
Expand Down Expand Up @@ -199,7 +201,7 @@ <h4>Declaration</h4>
</div>
<div>
<h4>Return Value</h4>
<p>The result of <code>Heap</code>.<code>pull()</code> -&gt; <code>T?</code></p>
<p>The result of <code><a href="../Protocols/Heap.html#/s:4HeapAAPAAE4pull11ElementTypeQzSgyF">code&gt;.&lt;code&gt;pull()</a></code> -&gt; <code>T?</code></p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/swiftpackages/Heap/tree/main/Sources/Heap/Heap.swift#L162-L168">Show on GitHub</a>
Expand All @@ -215,8 +217,8 @@ <h4>Return Value</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
8 changes: 5 additions & 3 deletions docs/main/Structs/MaxHeap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Heap Reference</a>
<a class="breadcrumb" href="../index.html">Heap</a>
<img class="carat" src="../img/carat.png" alt=""/>
<a class="breadcrumb" href="../Structs.html">Structures</a>
<img class="carat" src="../img/carat.png" alt=""/>
MaxHeap Structure Reference
</p>
Expand Down Expand Up @@ -241,8 +243,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
8 changes: 5 additions & 3 deletions docs/main/Structs/MaxHeapRecursive.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Heap Reference</a>
<a class="breadcrumb" href="../index.html">Heap</a>
<img class="carat" src="../img/carat.png" alt=""/>
<a class="breadcrumb" href="../Structs.html">Structures</a>
<img class="carat" src="../img/carat.png" alt=""/>
MaxHeapRecursive Structure Reference
</p>
Expand Down Expand Up @@ -339,8 +341,8 @@ <h4>Parameters</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
8 changes: 5 additions & 3 deletions docs/main/Structs/MinHeap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Heap Reference</a>
<a class="breadcrumb" href="../index.html">Heap</a>
<img class="carat" src="../img/carat.png" alt=""/>
<a class="breadcrumb" href="../Structs.html">Structures</a>
<img class="carat" src="../img/carat.png" alt=""/>
MinHeap Structure Reference
</p>
Expand Down Expand Up @@ -241,8 +243,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
8 changes: 5 additions & 3 deletions docs/main/Structs/MinHeapRecursive.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Heap Reference</a>
<a class="breadcrumb" href="../index.html">Heap</a>
<img class="carat" src="../img/carat.png" alt=""/>
<a class="breadcrumb" href="../Structs.html">Structures</a>
<img class="carat" src="../img/carat.png" alt=""/>
MinHeapRecursive Structure Reference
</p>
Expand Down Expand Up @@ -339,8 +341,8 @@ <h4>Parameters</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
9 changes: 5 additions & 4 deletions docs/main/css/jazzy.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -259,10 +259,11 @@ pre code {
padding-left: 3px;
margin-left: 20px;
font-size: 1rem; }
.item .declaration-note {
font-size: .85em;
color: #808080;
font-style: italic; }

.declaration-note {
font-size: .85em;
color: #808080;
font-style: italic; }

.pointer-container {
border-bottom: 1px solid #ddd;
Expand Down
6 changes: 3 additions & 3 deletions docs/main/docsets/Heap.docset/Contents/Resources/Documents/Protocols.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Heap Reference</a>
<a class="breadcrumb" href="index.html">Heap</a>
<img class="carat" src="img/carat.png" alt=""/>
Protocols Reference
</p>
Expand Down Expand Up @@ -138,8 +138,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
16 changes: 9 additions & 7 deletions docs/main/docsets/Heap.docset/Contents/Resources/Documents/Protocols/Heap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Heap Reference</a>
<a class="breadcrumb" href="../index.html">Heap</a>
<img class="carat" src="../img/carat.png" alt=""/>
<a class="breadcrumb" href="../Protocols.html">Protocols</a>
<img class="carat" src="../img/carat.png" alt=""/>
Heap Protocol Reference
</p>
Expand Down Expand Up @@ -334,7 +336,7 @@ <h4>Declaration</h4>
</div>
<div>
<h4>Return Value</h4>
<p>The next item of type <code><a href="../Protocols/Heap.html#/s:4HeapAAP11ElementTypeQa">ElementType</a></code> from the <code>Heap</code> or, if the <code>Heap</code>.<code>isEmpty</code> return&rsquo;s <code>nil</code>.</p>
<p>The next item of type <code><a href="../Protocols/Heap.html#/s:4HeapAAP11ElementTypeQa">ElementType</a></code> from the <code>Heap</code> or, if the <code><a href="../Protocols/Heap.html#/s:4HeapAAP7isEmptySbvp">code&gt;.&lt;code&gt;isEmpty</a></code> return&rsquo;s <code>nil</code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/swiftpackages/Heap/tree/main/Sources/Heap/Heap.swift#L31-L36">Show on GitHub</a>
Expand Down Expand Up @@ -371,7 +373,7 @@ <h4>Declaration</h4>
</div>
<div>
<h4>Return Value</h4>
<p>The next item of type <code><a href="../Protocols/Heap.html#/s:4HeapAAP11ElementTypeQa">ElementType</a></code> from the <code>Heap</code> or, if the <code>Heap</code>.<code>isEmpty</code> return&rsquo;s <code>nil</code>.</p>
<p>The next item of type <code><a href="../Protocols/Heap.html#/s:4HeapAAP11ElementTypeQa">ElementType</a></code> from the <code>Heap</code> or, if the <code><a href="../Protocols/Heap.html#/s:4HeapAAP7isEmptySbvp">code&gt;.&lt;code&gt;isEmpty</a></code> return&rsquo;s <code>nil</code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/swiftpackages/Heap/tree/main/Sources/Heap/Heap.swift#L40-L51">Show on GitHub</a>
Expand Down Expand Up @@ -619,7 +621,7 @@ <h4>Parameters</h4>
</td>
<td>
<div>
<p>the parent index</p>
<p>the child index</p>
</div>
</td>
</tr>
Expand All @@ -628,7 +630,7 @@ <h4>Parameters</h4>
</div>
<div>
<h4>Return Value</h4>
<p>right child index</p>
<p>the parent index</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/swiftpackages/Heap/tree/main/Sources/Heap/Heap.swift#L87-L89">Show on GitHub</a>
Expand Down Expand Up @@ -1044,8 +1046,8 @@ <h4>Parameters</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2022 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2022-04-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
<p>&copy; 2024 <a class="link" href="https://github.com/marzvrover" target="_blank" rel="external noopener">Marz Rover</a>. All rights reserved. (Last updated: 2024-09-06)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>
Loading

0 comments on commit f0be7ac

Please sign in to comment.