[mkdocs] docs/ update

docs/index.html

@@ -25,7 +25,7 @@
 
 
 
-        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/github.min.css">
+        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/nord.min.css">
 
 
 
@@ -271,5 +271,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.4.2
-Build Date UTC : 2024-03-12 13:14:02.828811+00:00
+Build Date UTC : 2024-03-12 13:46:01.990849+00:00
 -->

docs/manual/dependencies/index.html

@@ -25,7 +25,7 @@
 
 
 
-        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/github.min.css">
+        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/nord.min.css">
 
 
 

docs/manual/manual/index.html

@@ -25,7 +25,7 @@
 
 
 
-        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/github.min.css">
+        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/nord.min.css">
 
 
 
@@ -157,91 +157,106 @@
         <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
     <ul class="nav bs-sidenav">
         <li class="first-level active"><a href="#syfala-toolchain-documentation">Syfala Toolchain Documentation</a></li>
+            <li class="second-level"><a href="#supported-board-models">Supported board models</a></li>
+
+            <li class="second-level"><a href="#dependencies">Dependencies</a></li>
+
+            <li class="second-level"><a href="#installing">Installing</a></li>
+
+            <li class="second-level"><a href="#getting-started">Getting started</a></li>
+
+                <li class="third-level"><a href="#hardware-setup-digilent-zybo-z7-1020-boards">Hardware setup (Digilent Zybo-Z7-10/20 boards)</a></li>
+                <li class="third-level"><a href="#software">Software</a></li>
+                <li class="third-level"><a href="#exporting-and-re-importing-your-builds">Exporting and re-importing your builds</a></li>
+                <li class="third-level"><a href="#building-another-dsp-target">Building another DSP target</a></li>
+            <li class="second-level"><a href="#tutorials">Tutorials</a></li>
+
+                <li class="third-level"><a href="#getting-started-with-syfala-and-faust">Getting started with syfala and Faust</a></li>
+                <li class="third-level"><a href="#embedded-linux">Embedded Linux</a></li>
+                <li class="third-level"><a href="#using-syfala-with-c-advanced">Using syfala with C++ (advanced)</a></li>
+            <li class="second-level"><a href="#going-further">Going further</a></li>
+
+            <li class="second-level"><a href="#the-syfala-team">The syfala team</a></li>
+
     </ul>
 </div></div>
         <div class="col-md-9" role="main">
 
 <h1 id="syfala-toolchain-documentation">Syfala Toolchain Documentation</h1>
-<ul>
-<li>Automatic compilation of Faust audio DSP programs for AMD-Xilinx FPGAs.</li>
-</ul>
-<p>## Supported board models</p>
+<p>Automatic compilation of Faust audio DSP programs for AMD-Xilinx FPGAs.</p>
+<h2 id="supported-board-models">Supported board models</h2>
 <ul>
 <li>[x] Digilent <strong>Zybo Z7-10</strong> - Zynq-7000 ARM/FPGA SoC Development Board</li>
 <li>[x] Digilent <strong>Zybo Z7-20</strong> - Zynq-7000 ARM/FPGA SoC Development Board</li>
 <li>[x] Digilent <strong>Genesys ZU-3EG</strong> - Zynq UltraScale+ MPSoC Development Board</li>
 </ul>
 <p>and more to come...</p>
-<p>## Dependencies</p>
+<h2 id="dependencies">Dependencies</h2>
 <p>Please follow the instructions in the file <a href="../dependencies/">doc/dependencies.md</a> in order to install the <strong>AMD-Xilinx</strong> <strong>toolchain</strong> and various other dependencies.</p>
-<p>## Installing</p>
+<h2 id="installing">Installing</h2>
 <p>the command <code>make install</code> will install a <strong>symlink</strong> in <strong>/usr/bin</strong>. After this you'll be able to just run: </p>
 <p><code>$ syfala myfaustprogram.dsp</code> </p>
 <p>You'll also have to <strong>edit</strong> your shell <strong>resource</strong> <strong>file</strong> (~/.<strong>bashrc</strong> / ~/.<strong>zshrc</strong>) and set the following environment variable: </p>
-<p><code>shell
-  export XILINX_ROOT_DIR=/my/path/to/Xilinx/root/directory</code></p>
+<pre><code class="language-shell">export XILINX_ROOT_DIR=/my/path/to/Xilinx/root/directory
+</code></pre>
 <p><code>XILINX_ROOT_DIR</code> is the root directory where all of the AMD-Xilinx tools (Vivado, Vitis, Vitis_HLS) are installed.</p>
-<p>## Getting started</p>
-<p>### Hardware setup (Digilent <strong>Zybo-Z7-10/20</strong> boards)</p>
+<h2 id="getting-started">Getting started</h2>
+<h3 id="hardware-setup-digilent-zybo-z7-1020-boards">Hardware setup (Digilent <strong>Zybo-Z7-10/20</strong> boards)</h3>
 <ul>
 <li>[ ] Jumper <strong>JP5</strong> should be on <em>JTAG</em> </li>
 <li>[ ] <strong>Power select</strong> jumper should be on <em>USB</em>  </li>
 <li>[ ] <strong>Switches</strong> SW0, SW1, SW2, SW3 should be <strong>down</strong>  </li>
 <li>[ ] The <strong>audio input</strong> is <strong>LINE IN</strong> (blue), not MIC IN  </li>
 <li>[ ] The <strong>audio output</strong> is the black <strong>HPH OUT</strong> jack  </li>
 </ul>
-<p>### Software</p>
-<p>#### Faust targets</p>
+<h3 id="software">Software</h3>
+<h4 id="faust-targets">Faust targets</h4>
 <p>Building a simple example for the <strong>default board</strong> (Digilent Zybo <strong>Z7-10)</strong>:</p>
-<p><code>shell
-  syfala examples/faust/virtualAnalog.dsp</code></p>
+<pre><code class="language-shell">syfala examples/faust/virtualAnalog.dsp
+</code></pre>
 <p>This will run the <strong>full syfala toolchain</strong> on the virtualAnalog.dsp <strong>Faust</strong> file, which will then be ready to be flashed on the board. Y<strong>ou can specify the targeted board</strong> using the <code>-b (--board)</code> option:</p>
-<p><code>shell
-  syfala examples/faust/virtualAnalog.dsp --board Z20
-  syfala examples/faust/virtualAnalog.dsp --board GENESYS</code></p>
+<pre><code class="language-shell">syfala examples/faust/virtualAnalog.dsp --board Z20
+syfala examples/faust/virtualAnalog.dsp --board GENESYS
+</code></pre>
 <p>You can now <strong>connect the board</strong> to your computer with the proper <strong>USB/Serial port cable</strong> and run the <code>flash</code> command:</p>
-<p><code>shell
-  syfala flash</code></p>
+<pre><code class="language-shell">syfala flash
+</code></pre>
 <p>The board's <strong>RGB LED</strong> should then flash <strong>green</strong> after a few seconds, indicating that your program is running. You can now <strong>start the Faust GUI application</strong>, which will display a set of sliders/knobs/buttons and <strong>update the DSP parameters in real-time through USB-UART</strong>:</p>
-<p><code>shell
-  syfala start-gui</code></p>
-<p>#### C++ targets</p>
+<pre><code class="language-shell">syfala start-gui
+</code></pre>
+<h4 id="c-targets">C++ targets</h4>
 <p>For C++ targets, the process is exactly the same (excepted for the GUI part, which is not available):</p>
-<p><code>shell
-  syfala examples/cpp/templates/bypass.cpp --board Z20
-  syfala flash</code></p>
-<p>### Exporting and re-importing your builds</p>
+<pre><code class="language-shell">syfala examples/cpp/templates/bypass.cpp --board Z20
+syfala flash
+</code></pre>
+<h3 id="exporting-and-re-importing-your-builds">Exporting and re-importing your builds</h3>
 <p>When you're done playing with your program, you can <strong>save and export it</strong> as a <code>.zip</code> file with the following command:</p>
-<p><code>shell
-  syfala export my-faust-virtual-analog-build
-  # output in 'export/my-faust-virtual-analog-build.zip'</code></p>
+<pre><code class="language-shell">syfala export my-faust-virtual-analog-build
+# output in 'export/my-faust-virtual-analog-build.zip'
+</code></pre>
 <p>The resulting <code>.zip</code> file is now available in the repository's <code>export</code> directory, you can <strong>re-import</strong> it by typing:</p>
-<p><code>shell
-  syfala import export/my-faust-virtual-analog-build.zip</code></p>
-<p>### Building another DSP target</p>
+<pre><code class="language-shell">syfala import export/my-faust-virtual-analog-build.zip
+</code></pre>
+<h3 id="building-another-dsp-target">Building another DSP target</h3>
 <p>Before building another DSP program, please <strong>make sure you have saved and exported your previous build</strong> beforehand, otherwise <strong>it will be overwritten</strong> whenever you start a new build. </p>
-<p><code>shell
-  syfala examples/my-new-dsp-build.dsp</code></p>
-<p>## Tutorials</p>
-<p>### Getting started with syfala and Faust</p>
+<pre><code class="language-shell">syfala examples/my-new-dsp-build.dsp
+</code></pre>
+<h2 id="tutorials">Tutorials</h2>
+<h3 id="getting-started-with-syfala-and-faust">Getting started with syfala and Faust</h3>
 <p><a href="../../tutorials/faust-getting-started/">tutorials/getting-started-faust.md</a></p>
 <p>In this tutorial, we will cover the essential topics to get you started with the <strong>Faust programming language</strong>, <strong>syfala</strong>, and audio programming on <strong>FPGAs</strong>. </p>
-<p>### Embedded Linux</p>
+<h3 id="embedded-linux">Embedded Linux</h3>
 <p>Please report to the <a href="../../tutorials/embedded-linux-getting-started/">linux/getting-started.md</a> document in order to get you started with the Embedded Linux for Syfala</p>
-<p>### Using syfala with C++ (advanced)</p>
+<h3 id="using-syfala-with-c-advanced">Using syfala with C++ (advanced)</h3>
 <p><a href="../../tutorials/cpp-tutorial-advanced/">tutorials/cpp-tutorial-advanced.md</a></p>
 <p>This tutorial will show you how to program a syfala DSP <em>kernel</em> using C++. It is intended for advanced users.</p>
-<p>## Going further</p>
+<h2 id="going-further">Going further</h2>
 <p>Please report to the <a href="../reference/">reference</a> for more information on available <strong>commands</strong>, <strong>options</strong> and documentation.</p>
-<p>## The syfala team</p>
+<h2 id="the-syfala-team">The syfala team</h2>
 <p>Here is a list of person that have contributed to the Syfala project :</p>
 <ul>
-<li>
-<p>Tanguy Risset</p>
-</li>
-<li>
-<p>Yann Orlarey </p>
-</li>
+<li>Tanguy Risset</li>
+<li>Yann Orlarey </li>
 <li>Romain Michon</li>
 <li>Stephane Letz</li>
 <li>Florent de Dinechin</li>

docs/manual/reference/index.html

@@ -25,7 +25,7 @@
 
 
 
-        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/github.min.css">
+        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/nord.min.css">
 
 
 

docs/tutorials/cpp-tutorial-advanced/index.html

@@ -25,7 +25,7 @@
 
 
 
-        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/github.min.css">
+        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/nord.min.css">
 
 
 

docs/tutorials/embedded-linux-getting-started/index.html

@@ -25,7 +25,7 @@
 
 
 
-        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/github.min.css">
+        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/nord.min.css">
 
 
 

docs/tutorials/faust-getting-started/index.html

@@ -25,7 +25,7 @@
 
 
 
-        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/github.min.css">
+        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/nord.min.css">