Skip to content

Commit

Permalink
Deploy to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] authored Mar 12, 2024
1 parent c7aafba commit 1b482c0
Show file tree
Hide file tree
Showing 8 changed files with 101 additions and 31 deletions.
Binary file modified latest/.doctrees/devguide.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified latest/.doctrees/installation.doctree
View file
Binary file not shown.
71 changes: 69 additions & 2 deletions latest/devguide.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,70 @@

<section id="developer-guide">
<h1>Developer Guide</h1>
<p>To be added.</p>
<section id="contributions">
<h2>Contributions</h2>
<p>Before contributing code:</p>
<ul>
<li><p>Fork [the repository](<a class="reference external" href="https://github.com/compas-dev/compas_slicer">https://github.com/compas-dev/compas_slicer</a>) and clone the fork.</p></li>
<li><p>Install compas_slicer from your local forked copy:</p>
<blockquote>
<div><div class="language-bash notranslate"><div class="highlight"><pre><button class="btn copy"><i class="far fa-copy"></i></button><code><span></span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</code></pre></div>
</div>
</div></blockquote>
</li>
<li><p>Install development dependencies:</p>
<blockquote>
<div><div class="language-bash notranslate"><div class="highlight"><pre><button class="btn copy"><i class="far fa-copy"></i></button><code><span></span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-dev.txt
</code></pre></div>
</div>
</div></blockquote>
</li>
<li><p>BEFORE you start working on your updates, make sure all tests pass:</p>
<blockquote>
<div><div class="language-bash notranslate"><div class="highlight"><pre><button class="btn copy"><i class="far fa-copy"></i></button><code><span></span>invoke<span class="w"> </span><span class="nb">test</span>
</code></pre></div>
</div>
</div></blockquote>
</li>
<li><p>BEFORE you start working on your updates, make sure you pass flake8 tests.</p>
<blockquote>
<div><div class="language-bash notranslate"><div class="highlight"><pre><button class="btn copy"><i class="far fa-copy"></i></button><code><span></span>invoke<span class="w"> </span>lint
</code></pre></div>
</div>
</div></blockquote>
</li>
<li><p>Now you can add your code in the appropriate folder. If you are not sure where to put it, contact <a class="reference external" href="https://github.com/ioannaMitropoulou">&#64;ioannaMitropoulou</a>.</p></li>
<li><p>Add an example in the examples folder that uses the new functionality. Run the example and ensure it works smoothly.</p></li>
<li><p>Add your name to the authors in README.md.</p></li>
<li><p>Make sure again that all tests pass, and that flake8 is also happy!</p></li>
<li><p>Create a [pull request](<a class="reference external" href="https://help.github.com/articles/about-pull-requests/">https://help.github.com/articles/about-pull-requests/</a>) for the master branch, where you explain in detail what you fixed. When you create a pull request, there is an automatic action that runs the tests for your code again on the server. Make sure the pull request passes the automatic tests as well. If not, inspect the result, find what went wrong, fix it, and push the result again to your branch. The action will run again automatically on the open pull request.</p></li>
</ul>
<p>During development, use [pyinvoke](<a class="reference external" href="http://docs.pyinvoke.org/">http://docs.pyinvoke.org/</a>) tasks on the
command line to ease recurring operations:</p>
<ul class="simple">
<li><p><cite>invoke clean</cite>: Clean all generated artifacts.</p></li>
<li><p><cite>invoke check</cite>: Run various code and documentation style checks.</p></li>
<li><p><cite>invoke docs</cite>: Generate documentation.</p></li>
<li><p><cite>invoke test</cite>: Run all tests and checks in one swift command.</p></li>
<li><p><cite>invoke</cite>: Show available tasks.</p></li>
</ul>
</section>
<section id="increase-version">
<h2>Increase version</h2>
<p>To increase the version of compas_slicer, do the following:</p>
<ul>
<li><p>Push all your changes to the main branch and make sure that your local copy is on the main branch and has no updates.</p></li>
<li><p>Use the command ‘release’ with the options major / minor / patch</p>
<blockquote>
<div><div class="language-bash notranslate"><div class="highlight"><pre><button class="btn copy"><i class="far fa-copy"></i></button><code><span></span>invoke<span class="w"> </span>release<span class="w"> </span>patch
</code></pre></div>
</div>
</div></blockquote>
</li>
</ul>
<p>This automatically pushes the new changes to pip. Conda forge will pick it up and in a few hours you will receive an email. Approve the PR request and then the updated version also goes to conda.</p>
</section>
</section>


Expand Down Expand Up @@ -193,7 +256,11 @@ <h1>Developer Guide</h1>
<div class="d-none d-xl-block col-xl-2 compas-toc" role="toc">

<ul class="nav flex-column" id="compas-toc">
<li class="nav-item"><a class="nav-link reference internal" href="#">Developer Guide</a></li>
<li class="nav-item"><a class="nav-link reference internal" href="#">Developer Guide</a><ul class="nav flex-column">
<li class="nav-item"><a class="nav-link reference internal" href="#contributions">Contributions</a></li>
<li class="nav-item"><a class="nav-link reference internal" href="#increase-version">Increase version</a></li>
</ul>
</li>
</ul>

</div>
Expand Down
40 changes: 19 additions & 21 deletions latest/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,26 +180,6 @@ <h3>Install compas slicer</h3>
<p>Enjoy!</p>
</section>
</section>
<section id="contributions">
<h2>Contributions</h2>
<p>Before contributing code:</p>
<ul class="simple">
<li><p>Install development dependencies:</p></li>
</ul>
<ul class="simple">
<li><p>Make sure all tests pass:</p></li>
</ul>
<ul class="simple">
<li><p>Make sure you pass flake8 tests. (hint: This is the most annoying part of the process)</p></li>
</ul>
<ul class="simple">
<li><p>Add your code in the appropriate folder. If you are not sure where to put it, contact [&#64;ioannaMitropoulou](<a class="reference external" href="https://github.com/ioannaMitropoulou">https://github.com/ioannaMitropoulou</a>).</p></li>
<li><p>Add an example on the examples folder that uses the new functionality. Run the example and make sure it works smoothly.</p></li>
<li><p>Add your name to the authors in README.md.</p></li>
<li><p>Create a pull request for the master branch, where you explain in detail what you fixed. When you create a pull request, there is an automatic action that runs the tests for your code again on the server.</p></li>
</ul>
<p>Make sure the pull request passes the automatic tests as well. If not, then inspect the result, find what went wrong, fix it, and push again the result on your branch. The action will run again automatically on the open pull request.</p>
</section>
<section id="troubleshooting">
<h2>Troubleshooting</h2>
<p>If you encounter a problem that is not described here, please file an issue
Expand Down Expand Up @@ -255,6 +235,23 @@ <h2>Troubleshooting</h2>
</code></pre></div>
</div>
</section>
<section id="bug-reports">
<h2>Bug reports</h2>
<p>When <a class="reference external" href="https://github.com/compas-dev/compas_slicer/issues">reporting a bug</a>, please include:</p>
<ul class="simple">
<li><p>Operating system name and version.</p></li>
<li><p>Any details about your local setup that might be helpful in troubleshooting.</p></li>
<li><p>Detailed steps to reproduce the bug.</p></li>
</ul>
</section>
<section id="feature-requests">
<h2>Feature requests</h2>
<p>When <a class="reference external" href="https://github.com/compas-dev/compas_slicer/issues">proposing a new feature</a>, please include:</p>
<ul class="simple">
<li><p>Explain in detail how it would work.</p></li>
<li><p>Keep the scope as narrow as possible, to make it easier to implement.</p></li>
</ul>
</section>
</section>


Expand Down Expand Up @@ -320,8 +317,9 @@ <h2>Troubleshooting</h2>
<li class="nav-item"><a class="nav-link reference internal" href="#install-compas-slicer">Install compas slicer</a></li>
</ul>
</li>
<li class="nav-item"><a class="nav-link reference internal" href="#contributions">Contributions</a></li>
<li class="nav-item"><a class="nav-link reference internal" href="#troubleshooting">Troubleshooting</a></li>
<li class="nav-item"><a class="nav-link reference internal" href="#bug-reports">Bug reports</a></li>
<li class="nav-item"><a class="nav-link reference internal" href="#feature-requests">Feature requests</a></li>
</ul>
</li>
</ul>
Expand Down
15 changes: 9 additions & 6 deletions latest/output.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,14 +124,17 @@
{"filename": "api/utilities.rst", "lineno": 1, "status": "unchecked", "code": 0, "uri": "#compas_slicer.utilities.smooth_vectors", "info": ""}
{"filename": "index.rst", "lineno": 11, "status": "working", "code": 0, "uri": "https://compas.dev/", "info": ""}
{"filename": "api/generated/compas_slicer.geometry.PrintPoint.rst", "lineno": 9, "status": "working", "code": 0, "uri": "https://compas.dev/compas/latest/api/generated/compas.geometry.Frame.html#compas.geometry.Frame", "info": ""}
{"filename": "api/generated/compas_slicer.geometry.PrintPoint.rst", "lineno": 7, "status": "working", "code": 0, "uri": "https://compas.dev/compas/latest/api/generated/compas.geometry.Vector.html#compas.geometry.Vector", "info": ""}
{"filename": "api/generated/compas_slicer.pre_processing.get_mid_pt_base.rst", "lineno": 3, "status": "working", "code": 0, "uri": "https://compas.dev/compas/latest/api/compas.datastructures.Mesh.html#compas.datastructures.Mesh", "info": ""}
{"filename": "api/generated/compas_slicer.geometry.Path.rst", "lineno": 4, "status": "working", "code": 0, "uri": "https://compas.dev/compas/latest/api/generated/compas.geometry.Point.html#compas.geometry.Point", "info": ""}
{"filename": "api/generated/compas_slicer.geometry.PrintPoint.rst", "lineno": 7, "status": "working", "code": 0, "uri": "https://compas.dev/compas/latest/api/generated/compas.geometry.Vector.html#compas.geometry.Vector", "info": ""}
{"filename": "api/generated/compas_slicer.geometry.Layer.rst", "lineno": 1, "status": "working", "code": 0, "uri": "https://docs.python.org/3/library/functions.html#object", "info": ""}
{"filename": "api/generated/compas_slicer.post_processing.simplify_paths_rdp.rst", "lineno": 1, "status": "working", "code": 0, "uri": "https://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm", "info": ""}
{"filename": "installation.rst", "lineno": 166, "status": "working", "code": 0, "uri": "https://stackoverflow.com/questions/66174862/import-error-cant-import-name-gcd-from-fractions", "info": ""}
{"filename": "examples/02_curved_slicing_simple.rst", "lineno": 10, "status": "redirected", "code": 302, "uri": "https://dl.acm.org/doi/fullHtml/10.1145/3424630.3425408", "info": "https://dl.acm.org/doi/abs/10.1145/3424630.3425408"}
{"filename": "installation.rst", "lineno": 18, "status": "redirected", "code": 302, "uri": "https://conda.io/docs/", "info": "https://conda.io/projects/conda/en/latest/"}
{"filename": "installation.rst", "lineno": 142, "status": "working", "code": 0, "uri": "https://www.scivision.dev/python-windows-visual-c-14-required/", "info": ""}
{"filename": "devguide.rst", "lineno": 48, "status": "redirected", "code": 302, "uri": "http://docs.pyinvoke.org/", "info": "https://docs.pyinvoke.org/en/stable/"}
{"filename": "devguide.rst", "lineno": 11, "status": "working", "code": 0, "uri": "https://github.com/compas-dev/compas_slicer", "info": ""}
{"filename": "index.rst", "lineno": 15, "status": "working", "code": 0, "uri": "https://github.com/compas-dev/compas_slicer/issues", "info": ""}
{"filename": "installation.rst", "lineno": 94, "status": "working", "code": 0, "uri": "https://github.com/ioannaMitropoulou", "info": ""}
{"filename": "installation.rst", "lineno": 18, "status": "redirected", "code": 302, "uri": "https://conda.io/docs/", "info": "https://conda.io/projects/conda/en/latest/"}
{"filename": "installation.rst", "lineno": 133, "status": "working", "code": 0, "uri": "https://stackoverflow.com/questions/66174862/import-error-cant-import-name-gcd-from-fractions", "info": ""}
{"filename": "devguide.rst", "lineno": 45, "status": "redirected", "code": 302, "uri": "https://help.github.com/articles/about-pull-requests/", "info": "https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests"}
{"filename": "installation.rst", "lineno": 109, "status": "working", "code": 0, "uri": "https://www.scivision.dev/python-windows-visual-c-14-required/", "info": ""}
{"filename": "examples/02_curved_slicing_simple.rst", "lineno": 10, "status": "redirected", "code": 302, "uri": "https://dl.acm.org/doi/fullHtml/10.1145/3424630.3425408", "info": "https://dl.acm.org/doi/abs/10.1145/3424630.3425408"}
{"filename": "devguide.rst", "lineno": 37, "status": "working", "code": 0, "uri": "https://github.com/ioannaMitropoulou", "info": ""}
4 changes: 3 additions & 1 deletion latest/output.txt
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
examples/02_curved_slicing_simple.rst:10: [redirected with Found] https://dl.acm.org/doi/fullHtml/10.1145/3424630.3425408 to https://dl.acm.org/doi/abs/10.1145/3424630.3425408
devguide.rst:48: [redirected with Found] http://docs.pyinvoke.org/ to https://docs.pyinvoke.org/en/stable/
installation.rst:18: [redirected with Found] https://conda.io/docs/ to https://conda.io/projects/conda/en/latest/
devguide.rst:45: [redirected with Found] https://help.github.com/articles/about-pull-requests/ to https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
examples/02_curved_slicing_simple.rst:10: [redirected with Found] https://dl.acm.org/doi/fullHtml/10.1145/3424630.3425408 to https://dl.acm.org/doi/abs/10.1145/3424630.3425408
2 changes: 1 addition & 1 deletion latest/searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 1b482c0

Please sign in to comment.