Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
GitHub Action 2022-09-15 18:24:17 +00:00
parent 8db67562e6
commit 337adab5cb
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/_sources/contributing.rst.txt
View File

@ -7,11 +7,11 @@ In order to keep the source code in good condition I use `pre-commit <https://pr
.. note::
If you are using Windows as a base platform I would suggest that you install pre-commit under wsl (Windows Subssytem for Windows) and run it from there, I have found
If you are using Windows as a base platform I would suggest that you install pre-commit under wsl (Windows Subsystem for Windows) and run it from there, I have found
that this approach works fine.
The following command will run pre-commit on all the source files. Assuming you are inte project directory.
The following command will run pre-commit on all the source files. Assuming you are in the project directory.
.. code-block::

4
docs/contributing.html
View File

@ -203,10 +203,10 @@
<p>In order to keep the source code in good condition I use <a class="reference external" href="https://pre-commit.com/">pre-commit</a> to validate and format the code using their standards for C++/C.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you are using Windows as a base platform I would suggest that you install pre-commit under wsl (Windows Subssytem for Windows) and run it from there, I have found
<p>If you are using Windows as a base platform I would suggest that you install pre-commit under wsl (Windows Subsystem for Windows) and run it from there, I have found
that this approach works fine.</p>
</div>
<p>The following command will run pre-commit on all the source files. Assuming you are inte project directory.</p>
<p>The following command will run pre-commit on all the source files. Assuming you are in the project directory.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pre</span><span class="o">-</span><span class="n">commit</span> <span class="n">run</span> <span class="o">--</span><span class="n">files</span> <span class="n">src</span><span class="o">/*</span>
</pre></div>
</div>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long