deploy: 2d33e03

analogdevicesinc · Jan 14, 2025 · 07de542 · 07de542
1 parent f7e7e97
commit 07de542
Show file tree

Hide file tree

Showing 120 changed files with 435 additions and 382 deletions.
diff --git a/_static/pygments.css b/_static/pygments.css
diff --git a/_static/style.min.css b/_static/style.min.css
diff --git a/_static/style.min.css.map b/_static/style.min.css.map
diff --git a/contributing/creating_new_pages.html b/contributing/creating_new_pages.html
@@ -7,7 +7,7 @@
 
     <title>Creating new pages &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=a9555194" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/contributing/docs_guidelines.html b/contributing/docs_guidelines.html
@@ -7,7 +7,7 @@
 
     <title>Documentation guidelines &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=a9555194" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/contributing/forking_publishing.html b/contributing/forking_publishing.html
@@ -7,7 +7,7 @@
 
     <title>Forking and publishing &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=a9555194" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
@@ -105,7 +105,11 @@
 <li><a class="reference internal" href="#branch">Branch</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#preparing-your-environment">Preparing your environment</a></li>
+<li><a class="reference internal" href="#preparing-your-environment">Preparing your environment</a><ul>
+<li><a class="reference internal" href="#using-your-local-host">Using your local host</a></li>
+<li><a class="reference internal" href="#github-codespace">GitHub Codespace</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#adding-content">Adding content</a></li>
 <li><a class="reference internal" href="#pushing-and-triggering-the-ci">Pushing and triggering the CI</a></li>
 <li><a class="reference internal" href="#resuming-work-at-a-later-time">Resuming work at a later time</a></li>
@@ -353,24 +357,29 @@
 </div>
 <section id="preparing-your-origin">
 <h2>Preparing your origin<a class="headerlink" href="#preparing-your-origin" title="Link to this heading"></a></h2>
-<p>There is three options to host your work, for users:</p>
+<p>There is three options to contribute:</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="#forking-publishing-fork"><span class="std std-ref">Fork</span></a>: that want to use the GitHub flow (recommended).</p></li>
 <li><p><a class="reference internal" href="#forking-publishing-copy"><span class="std std-ref">Copy</span></a>: that want to work privately first.</p></li>
 <li><p><a class="reference internal" href="#forking-publishing-branch"><span class="std std-ref">Branch</span></a>: with write access to <em>analogdevicesinc</em> organization.</p></li>
 </ul>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>If using Github Codespaces, just fork/create a branch/copy and follow
+<a class="reference internal" href="#forking-publishing-github-codespaces"><span class="std std-ref">this section</span></a>.</p>
+</div>
 <section id="fork">
 <span id="forking-publishing-fork"></span><h3>Fork<a class="headerlink" href="#fork" title="Link to this heading"></a></h3>
-<p>Ensure git-lfs is installed with:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>git-lfs<span class="w"> </span>-y
-</pre></div>
-</div>
 <p>Fork the <em>analogdevicesinc/documentation</em> repo on your account.</p>
 <div class="line-block">
 <div class="line"><strong>Enable the workflows</strong> on the forked repo at <em>github.com/&lt;your_user&gt;/documentation/actions</em>
 by clicking the green button</div>
 <div class="line">“I understand my workflows, go ahead and enable them”.</div>
 </div>
+<p>Ensure git-lfs is installed with:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>git-lfs<span class="w"> </span>-y
+</pre></div>
+</div>
 <p>Clone the repository:</p>
 <div class="code-shell"><div><div class="no-select float-left highlight-default notranslate"><div class="highlight"><pre><span></span>~$
 </pre></div>
@@ -480,7 +489,16 @@ <h2>Preparing your origin<a class="headerlink" href="#preparing-your-origin" tit
 </section>
 <section id="preparing-your-environment">
 <h2>Preparing your environment<a class="headerlink" href="#preparing-your-environment" title="Link to this heading"></a></h2>
-<p>Clone and build the doc for the first time (working directory: repo root):</p>
+<p>It is possible to contribute:</p>
+<ul class="simple">
+<li><p><a class="reference internal" href="#forking-publishing-local"><span class="std std-ref">Using your local host</span></a> (most freedom); or with</p></li>
+<li><p>A <a class="reference internal" href="#forking-publishing-github-codespaces"><span class="std std-ref">GitHub Codespace</span></a>.</p></li>
+</ul>
+<p>Follow either tutorial to bring up the environment.</p>
+<section id="using-your-local-host">
+<span id="forking-publishing-local"></span><h3>Using your local host<a class="headerlink" href="#using-your-local-host" title="Link to this heading"></a></h3>
+<p>To prepare your environment to work <strong>locally</strong>,
+clone and build the doc for the first time (working directory: repo root):</p>
 <p>Ensure pip is up-to-date:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>pip<span class="w"> </span>--upgrade
 </pre></div>
@@ -514,6 +532,33 @@ <h2>Preparing your environment<a class="headerlink" href="#preparing-your-enviro
 </pre></div>
 </div>
 <div class="clear-left"></div></div></div></section>
+<section id="github-codespace">
+<span id="forking-publishing-github-codespaces"></span><h3>GitHub Codespace<a class="headerlink" href="#github-codespace" title="Link to this heading"></a></h3>
+<p>Instead of working locally, you can use a cloud virtual machine with
+GitHub Codespaces.</p>
+<p>GitHub Codespaces uses the <a class="icon git reference external" href="https://github.com/analogdevicesinc/documentation/tree/main/.devcontainer.json">.devcontainer.json</a> file to
+initialize a container in the cloud.
+This container is pre-configured with all the tools required to build the
+documentation, including the live preview daemon  <a class="reference external" href="https://analogdevicesinc.github.io/doctools/cli.html#serve" title="(in Doctools v0.3)"><span>Serve</span></a>,
+which is automatically started.
+This setup provides a user experience comparable to platforms like Google Docs
+or Overleaf.</p>
+<div class="admonition caution">
+<p class="admonition-title">Caution</p>
+<div class="line-block">
+<div class="line">GitHub Codespaces usage is billed to the user (you)!</div>
+<div class="line">Be sure to understand GitHub’s billing policies and your account free quota.</div>
+</div>
+</div>
+<p>To use GitHub Codespaces, navigate to the
+<a class="icon git reference external" href="https://github.com/analogdevicesinc/documentation/">GitHub GUI for this repository</a> and click
+<em>Code &gt; Codespaces &gt; Create codespace on main</em>.</p>
+<p>This will open a new tab and set up the virtual environment.
+The setup is complete  when the live preview panel appears on the right.</p>
+<p>To manage all your GitHub Codespaces and shut them down, visit
+<a class="reference external" href="https://github.com/codespaces">github.com/codespaces</a>.</p>
+</section>
+</section>
 <section id="adding-content">
 <h2>Adding content<a class="headerlink" href="#adding-content" title="Link to this heading"></a></h2>
 <p>Add a new topic and pages (working directory: docs).</p>

diff --git a/contributing/index.html b/contributing/index.html
@@ -7,7 +7,7 @@
 
     <title>Contributing and guidelines &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=a9555194" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
@@ -335,7 +335,11 @@ <h1>Contributing and guidelines<a class="headerlink" href="#contributing-and-gui
 <li class="toctree-l3"><a class="reference internal" href="forking_publishing.html#branch">Branch</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="forking_publishing.html#preparing-your-environment">Preparing your environment</a></li>
+<li class="toctree-l2"><a class="reference internal" href="forking_publishing.html#preparing-your-environment">Preparing your environment</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="forking_publishing.html#using-your-local-host">Using your local host</a></li>
+<li class="toctree-l3"><a class="reference internal" href="forking_publishing.html#github-codespace">GitHub Codespace</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="forking_publishing.html#adding-content">Adding content</a></li>
 <li class="toctree-l2"><a class="reference internal" href="forking_publishing.html#pushing-and-triggering-the-ci">Pushing and triggering the CI</a></li>
 <li class="toctree-l2"><a class="reference internal" href="forking_publishing.html#resuming-work-at-a-later-time">Resuming work at a later time</a></li>

diff --git a/eval/index.html b/eval/index.html
@@ -7,7 +7,7 @@
 
     <title>Evaluation Boards &amp; Platforms &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../_static/style.min.css?v=a9555194" />
     <script src="../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9009/basic-iq-datafiles.html b/eval/user-guide/adrv9009/basic-iq-datafiles.html
@@ -7,7 +7,7 @@
 
     <title>Basic IQ Datafiles &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=a9555194" />
     <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9009/index.html b/eval/user-guide/adrv9009/index.html
@@ -7,7 +7,7 @@
 
     <title>ADRV9009 &amp; ADRV9008 &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=a9555194" />
     <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9009/prerequisites.html b/eval/user-guide/adrv9009/prerequisites.html
@@ -7,7 +7,7 @@
 
     <title>Prerequisites &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=a9555194" />
     <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9009/quickstart/index.html b/eval/user-guide/adrv9009/quickstart/index.html
@@ -7,7 +7,7 @@
 
     <title>Quickstart &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=a9555194" />
     <script src="../../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9009/quickstart/zynqmp.html b/eval/user-guide/adrv9009/quickstart/zynqmp.html
@@ -7,7 +7,7 @@
 
     <title>ZCU102 Quickstart &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=a9555194" />
     <script src="../../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9026/index.html b/eval/user-guide/adrv9026/index.html
@@ -7,7 +7,7 @@
 
     <title>ADRV9026 &amp; ADRV9029 &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=a9555194" />
     <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9026/prerequisites.html b/eval/user-guide/adrv9026/prerequisites.html
@@ -7,7 +7,7 @@
 
     <title>Prerequisites &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=a9555194" />
     <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9026/quickstart/index.html b/eval/user-guide/adrv9026/quickstart/index.html
@@ -7,7 +7,7 @@
 
     <title>Quickstart &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=a9555194" />
     <script src="../../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9026/quickstart/versal.html b/eval/user-guide/adrv9026/quickstart/versal.html
@@ -7,7 +7,7 @@
 
     <title>VCK190 Quickstart &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=a9555194" />
     <script src="../../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/adrv9026/quickstart/zynqmp.html b/eval/user-guide/adrv9026/quickstart/zynqmp.html
@@ -7,7 +7,7 @@
 
     <title>ZCU102 Quickstart &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../../_static/style.min.css?v=a9555194" />
     <script src="../../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/eval-adxl355-pmdz/index.html b/eval/user-guide/eval-adxl355-pmdz/index.html
@@ -7,7 +7,7 @@
 
     <title>EVAL-ADXL355-PMDZ User Guide &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/style.min.css?v=a9555194" />
     <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/eval/user-guide/index.html b/eval/user-guide/index.html
@@ -7,7 +7,7 @@
 
     <title>User guides &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../../_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="../../_static/style.min.css?v=a9555194" />
     <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>

diff --git a/genindex.html b/genindex.html
@@ -6,7 +6,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Index &#8212; System Level Documentation  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="_static/style.min.css?v=7f94efc5" />
+    <link rel="stylesheet" type="text/css" href="_static/style.min.css?v=a9555194" />
     <script src="_static/documentation_options.js?v=5929fcd5"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>