Skip to content

Commit

Permalink
docs generated
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Bakera committed Dec 31, 2023
1 parent c89c712 commit 3f9d708
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 9 deletions.
7 changes: 3 additions & 4 deletions docs/_modules/web.html
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,6 @@ <h1>Source code for web</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">js</span><span class="p">,</span> <span class="mi">200</span></div>


<span class="c1"># TODO add support for led brightness</span>
<div class="viewcode-block" id="route_display_post">
<a class="viewcode-back" href="../web.html#web.route_display_post">[docs]</a>
<span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">&quot;/display&quot;</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;POST&#39;</span><span class="p">])</span>
Expand Down Expand Up @@ -336,9 +335,9 @@ <h1>Source code for web</h1><div class="highlight"><pre>

<span class="sd"> To set the led brightness, send a json with the led value::</span>
<span class="sd"> </span>
<span class="sd"> {</span>
<span class="sd"> &quot;led&quot;: &quot;on&quot; # or &quot;off&quot;</span>
<span class="sd"> }</span>
<span class="sd"> {</span>
<span class="sd"> &quot;led&quot;: &quot;on&quot; # or &quot;off&quot;</span>
<span class="sd"> }</span>
<span class="sd"> </span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">get_json</span><span class="p">()</span>
Expand Down
5 changes: 1 addition & 4 deletions docs/developer.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,7 @@ <h2>Creating the documentation<a class="headerlink" href="#creating-the-document
in <code class="docutils literal notranslate"><span class="pre">docgen/_build/html</span></code>. It will automaticall be copied to <code class="docutils literal notranslate"><span class="pre">docs</span></code>.
After pushing to github it will be available
<a class="reference external" href="https://tbs1-bo.github.io/flipflapflop/">there</a>.</p>
<p>There is a <code class="docutils literal notranslate"><span class="pre">gitlab-ci.yml</span></code> script that will only be executed if the project is
hosted on a gitlab server. The script automatically deploys the documentation
on every commit onto the master branch. An examples can be found
<a class="reference external" href="https://tbs1-bo.gitlab.io/flipflapflop/">here</a>.</p>
<p>TODO: maybe switch to readthedocs.io</p>
</section>
<section id="class-diagram">
<h2>Class Diagram<a class="headerlink" href="#class-diagram" title="Link to this heading"></a></h2>
Expand Down
Loading

0 comments on commit 3f9d708

Please sign in to comment.