Skip to content

Commit

Permalink
Deployed 73a9a8f to latest with MkDocs 1.6.1 and mike 2.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
rturrado committed Nov 29, 2024
1 parent 2034a5b commit aa5b1ae
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
18 changes: 15 additions & 3 deletions latest/dev-guide/dev-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,7 @@ <h3 id="options">Options</h3>
<p>Tests are disabled by default. To enable them, use <code>-c tools.build:skip_test=False</code>.</p>
<h3 id="documentation_1">Documentation</h3>
<p>Build and serve on <code>http://127.0.0.1:8000/</code>.</p>
<pre><code class="language-shell">export PTYHONPATH=./scripts/python
<pre><code class="language-shell">export PYTHONPATH=./scripts/python
mkdocs serve
</code></pre>
<div class="admonition note">
Expand All @@ -1195,11 +1195,23 @@ <h2 id="linters_1">Linters</h2>
<li>Code style checks are defined in <code>.clang-tidy</code>.</li>
</ul>
<p>It is recommended to run these linters before pushing any change:</p>
<pre><code class="language-shell">python3 ./scripts/run_cpp_linters.py .
<pre><code class="language-shell">conan build . -pr:a=conan/profiles/tests-release-gcc-linux-x64 -b missing
python3 ./scripts/run_cpp_linters.py .
</code></pre>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The linters require <code>clang-format-18</code> and <code>clang-tidy-18</code> to be installed on the system.</p>
<ul>
<li>The linters require<code>clang-format-18</code> and <code>clang-tidy-18</code>. </li>
<li>It is mandatory to have a build before running the linters.<ul>
<li><code>clang-tidy</code> expects to find a <code>compile_commands.json</code> in a build folder.</li>
</ul>
</li>
<li>It is recommended to build with <em>gcc</em> in <em>Release</em> mode.<ul>
<li>We have observed <code>clang-tidy</code> fails to find some standard headers when compiling with <em>clang</em>.</li>
<li><code>run_cpp_linters.py</code> can receive a build folder as second argument, but defaults to <code>build/Release</code>.</li>
</ul>
</li>
</ul>
</div>
<h2 id="docker">Docker</h2>
<p>This tests the library in a container with the bare minimum requirements for libQASM.</p>
Expand Down
Loading

0 comments on commit aa5b1ae

Please sign in to comment.