Deploying to gh-pages from @ d7bac42 🚀

Author: Halbaroth

next/API/index.html

@@ -11,8 +11,8 @@
       <div class="by-name">
       <h2>OCaml package documentation</h2>
       <ol>
-      <li><a href="alt-ergo/index.html">alt-ergo</a> <span class="version">5f65a22</span></li>
-      <li><a href="alt-ergo-lib/index.html">alt-ergo-lib</a> <span class="version">5f65a22</span></li>
+      <li><a href="alt-ergo/index.html">alt-ergo</a> <span class="version">d7bac42</span></li>
+      <li><a href="alt-ergo-lib/index.html">alt-ergo-lib</a> <span class="version">d7bac42</span></li>
       </ol>
       </div>
     </main>

next/Alt_ergo_native/02_types/02_01_builtin.html

@@ -61,6 +61,8 @@
 <li class="toctree-l3"><a class="reference internal" href="#pull-request-guidelines">Pull Request Guidelines</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#legal-guidelines">Legal Guidelines</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#develop-with-nix">Develop with Nix</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#develop-with-opam">Develop with Opam</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#build-the-project-with-makefile">Build the project with Makefile</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#release-process">Release Process</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#make-a-pr-for-the-release">Make a PR for the release</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#update-documentation">Update documentation</a></li>
@@ -143,6 +145,49 @@ <h2>Develop with Nix<a class="headerlink" href="#develop-with-nix" title="Permal
 </pre></div>
 </div>
 </section>
+<section id="develop-with-opam">
+<h2>Develop with Opam<a class="headerlink" href="#develop-with-opam" title="Permalink to this heading"></a></h2>
+<p>If you are using opam, you can set up a switch development for Alt-Ergo using:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>dev-switch
+</pre></div>
+</div>
+<p>This command creates a local switch with all the dependencies required for
+building the Alt-Ergo binary and library.</p>
+<p>To install dependencies for the JavaScript artifacts of Alt-Ergo in the
+current switch, run:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>js-deps
+</pre></div>
+</div>
+</section>
+<section id="build-the-project-with-makefile">
+<h2>Build the project with Makefile<a class="headerlink" href="#build-the-project-with-makefile" title="Permalink to this heading"></a></h2>
+<p>Once you have set up a development environment, you can use the following
+Makefile targets to compile different parts of the project:</p>
+<table class="docutils align-default">
+<thead>
+<tr class="row-odd"><th class="head"><p>Target</p></th>
+<th class="head"><p>Description</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">bin</span></code></p></td>
+<td><p>Builds the Alt-Ergo binary and library.</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">lib</span></code></p></td>
+<td><p>Builds only the Alt-Ergo library.</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">js</span></code></p></td>
+<td><p>Builds the Alt-Ergo artifacts for JavaScript.</p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">plugins</span></code></p></td>
+<td><p>Builds the Alt-Ergo plugins.</p></td>
+</tr>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">make</span></code></p></td>
+<td><p>Builds everything.</p></td>
+</tr>
+</tbody>
+</table>
+</section>
 <section id="release-process">
 <h2>Release Process<a class="headerlink" href="#release-process" title="Permalink to this heading"></a></h2>
 <p>Alt-Ergo releases do not have a fixed schedule and are made based on features. We try to maintain the main branch (<code class="docutils literal notranslate"><span class="pre">next</span></code>) of the repository as stable as possible, and cut a release from there when an important feature is complete. We also make point release to fix important bugs.</p>

next/Dev/contributing.html

@@ -22,7 +22,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Project Architecture" href="architecture.html" />
-    <link rel="prev" title="What is this plugin ?" href="../Plugins/ab_why3.html" /> 
+    <link rel="prev" title="Plugins" href="../Plugins/index.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -96,6 +96,8 @@ <h1>Developer’s documentation<a class="headerlink" href="#developer-s-document
 <li class="toctree-l2"><a class="reference internal" href="contributing.html#pull-request-guidelines">Pull Request Guidelines</a></li>
 <li class="toctree-l2"><a class="reference internal" href="contributing.html#legal-guidelines">Legal Guidelines</a></li>
 <li class="toctree-l2"><a class="reference internal" href="contributing.html#develop-with-nix">Develop with Nix</a></li>
+<li class="toctree-l2"><a class="reference internal" href="contributing.html#develop-with-opam">Develop with Opam</a></li>
+<li class="toctree-l2"><a class="reference internal" href="contributing.html#build-the-project-with-makefile">Build the project with Makefile</a></li>
 <li class="toctree-l2"><a class="reference internal" href="contributing.html#release-process">Release Process</a></li>
 </ul>
 </li>
@@ -107,7 +109,7 @@ <h1>Developer’s documentation<a class="headerlink" href="#developer-s-document
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="../Plugins/ab_why3.html" class="btn btn-neutral float-left" title="What is this plugin ?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="../Plugins/index.html" class="btn btn-neutral float-left" title="Plugins" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="architecture.html" class="btn btn-neutral float-right" title="Project Architecture" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>