Skip to content

Commit

Permalink
Merge pull request #68 from 10x-Engineers/alitariq4589/kendryte_docs
Browse files Browse the repository at this point in the history 
Alitariq4589/kendryte docs
  • Loading branch information
@mmhus
mmhus authored May 21, 2024
2 parents 9217f9c + 993f7dd commit cc0c29e
Show file tree
Hide file tree
Showing 22 changed files with 368 additions and 19 deletions.
3 changes: 2 additions & 1 deletion build_mkdocs.sh
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
cd mkdocs_src
#!/bin/bash
cd mkdocs_src || exit
mkdocs gh-deploy -d ../docs
cd ..
git add .
2 changes: 2 additions & 0 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="/tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/Creating_CI_CD_pipeline/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/Creating_jenkinsfile/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/Multinode_Pipelines/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/Software_Developer_Guide/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/Tooling/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down
4 changes: 3 additions & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -147,5 +149,5 @@ <h1 id="cloud-v-documentation">Cloud-V Documentation</h1>

<!--
MkDocs version : 1.5.3
Build Date UTC : 2024-04-17 07:18:46.831530+00:00
Build Date UTC : 2024-05-09 07:52:14.942979+00:00
-->
2 changes: 2 additions & 0 deletions docs/jenkins_gitlab_integration/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down
26 changes: 26 additions & 0 deletions docs/runner_specs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -102,6 +104,7 @@ <h1 id="specifications-of-compute-instances-in-cloud-v">Specifications of comput
<tr>
<th>Name String</th>
<th>Architecture</th>
<th>ISA String</th>
<th>Cores</th>
<th>Memory</th>
<th>Compute Instance Type</th>
Expand All @@ -111,103 +114,126 @@ <h1 id="specifications-of-compute-instances-in-cloud-v">Specifications of comput
<tr>
<td>J-x86-1 (or) J-QMU-1</td>
<td>x86_64</td>
<td>N/A</td>
<td>4</td>
<td>8GiB</td>
<td>Hardware with application-level emulator</td>
</tr>
<tr>
<td>J-TESTVM-1</td>
<td>x86_64</td>
<td>N/A</td>
<td>4</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-RASP4-1</td>
<td>aarch64</td>
<td>ARMv8-A</td>
<td>4</td>
<td>4GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-QMS-1</td>
<td>riscv64</td>
<td>See Ext 1 at bottom</td>
<td>2</td>
<td>2GiB</td>
<td>QEMU System emulator</td>
</tr>
<tr>
<td>J-VF1-1</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>2</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-VF1-2</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>2</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-VF1-3</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>2</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-VF2-1</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>4</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-VF2-2</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>4</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-VF2-3</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>4</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-VF2-4</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>4</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-VF2-5</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>4</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-VF2-6</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>4</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-HF-1</td>
<td>riscv64</td>
<td>rv64imafdc</td>
<td>4</td>
<td>8GiB</td>
<td>Hardware</td>
</tr>
<tr>
<td>J-K230-1</td>
<td>riscv64</td>
<td>rv64imafdcvxthead</td>
<td>1</td>
<td>512MiB</td>
<td>Hardware</td>
</tr>
</tbody>
</table>
<p><em><strong>Ext1:</strong> rv64imafdch_zicbom_zicboz_zicntr_zicsr_zifencei_zihintpause_zihpm_zba_zbb_zbs_sstc</em></p>
<p><em><strong>Note:</strong> The <code>J-QMU-1</code> and <code>J-x86-1</code> are one and the same runner. The purpose of creating two separate executors for same hardware is that <code>J-x86-1</code> is supposed to be specifically for x86 architecture whereas <code>J-QMU-1</code> is specifically for the users who want to cross compile source code for riscv64 architecture and then use qemu-usermode to execute them. Nevertheless, the tooling available for <code>J-x86-1</code> can also be used for <code>J-QMU-1</code></em></p>

</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="./tooling_J-HF-1/">J-HF-1</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/search/search_index.json
View file

Large diffs are not rendered by default.

Binary file modified docs/sitemap.xml.gz
View file
Binary file not shown.
5 changes: 5 additions & 0 deletions docs/tooling_J-HF-1/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tooling_J-K230-1/">J-K230-1</a>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -205,6 +207,7 @@ <h1 id="tools-on-j-hf-1-node">Tools on <code>J-HF-1</code> node</h1>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../tooling_J-VF2-x/" class="btn btn-neutral float-left" title="J-VF2-x"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../tooling_J-K230-1/" class="btn btn-neutral float-right" title="J-K230-1">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

<hr/>
Expand All @@ -230,6 +233,8 @@ <h1 id="tools-on-j-hf-1-node">Tools on <code>J-HF-1</code> node</h1>
<span><a href="../tooling_J-VF2-x/" style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../tooling_J-K230-1/" style="color: #fcfcfc">Next &raquo;</a></span>

</span>
</div>
<script src="../js/jquery-3.6.0.min.js"></script>
Expand Down
Loading

0 comments on commit cc0c29e

Please sign in to comment.