Deploying to gh-pages from @ wanadev/yoga@9e28095ba6 🚀

_sources/contributing.rst.txt

@@ -96,15 +96,17 @@ Linux as operating system and a POSIX shell (like Bash or ZSH).
 
 Programming languages used in this project:
 
-* Python_ (2.7, 3.7, 3.8 and 3.9)
+* Python_ (3.8 to 3.12)
 * C++
 
 Libraries:
 
 * CFFI_: C/Python binding
+* imagequant_: Color quantization (to reduce number of colors in an image)
+* mozjpeg-lossless-optimization_: Lossless JPEG optimization
 * Pillow_: Image processing library
 * PyGuetzli_: JPEG optimization
-* ZopfliPy_: PNG Optimization
+* ZopfliPy_: PNG optimization
 
 Development tools:
 
@@ -249,9 +251,37 @@ Then you can run the following command::
     nox -s gendoc
 
 
+Updating ASSIMP
+---------------
+
+ASSIMP is the C++ library used by YOGA to manipulate 3D models. To update it,
+first check the latest version tag on the project's repo :
+
+* https://github.com/assimp/assimp/tags
+
+Then go to the assimp subfolder and checkout the latest release tag::
+
+    cd assimp/
+    git fetch
+    git checkout vX.Y.Z
+    cd ..
+
+Then, run tests to ensure YOGA still work::
+
+    nox -s test
+
+Finally, check we are still able to build a wheel from the sdist package::
+
+    nox -s test_build_wheel
+
+If the build fails because of a missing file, add it in ``MANIFEST.in``.
+
+
 .. _Python: https://www.python.org/
 
 .. _CFFI: https://cffi.readthedocs.io/en/latest/
+.. _imagequant: https://github.com/wanadev/imagequant-python
+.. _mozjpeg-lossless-optimization: https://github.com/wanadev/mozjpeg-lossless-optimization
 .. _Pillow: https://pillow.readthedocs.io/en/stable/
 .. _PyGuetzli: https://github.com/wanadev/pyguetzli
 .. _ZopfliPy: https://github.com/hattya/zopflipy

contributing.html

@@ -72,6 +72,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#building-the-documentation">Building the Documentation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#updating-assimp">Updating ASSIMP</a></li>
 </ul>
 </li>
 </ul>
@@ -186,15 +187,17 @@ useful information to start. Please note that this guide assume you are using
 Linux as operating system and a POSIX shell (like Bash or ZSH).</p>
 <p>Programming languages used in this project:</p>
 <ul class="simple">
-<li><p><a class="reference external" href="https://www.python.org/">Python</a> (2.7, 3.7, 3.8 and 3.9)</p></li>
+<li><p><a class="reference external" href="https://www.python.org/">Python</a> (3.8 to 3.12)</p></li>
 <li><p>C++</p></li>
 </ul>
 <p>Libraries:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="https://cffi.readthedocs.io/en/latest/">CFFI</a>: C/Python binding</p></li>
+<li><p><a class="reference external" href="https://github.com/wanadev/imagequant-python">imagequant</a>: Color quantization (to reduce number of colors in an image)</p></li>
+<li><p><a class="reference external" href="https://github.com/wanadev/mozjpeg-lossless-optimization">mozjpeg-lossless-optimization</a>: Lossless JPEG optimization</p></li>
 <li><p><a class="reference external" href="https://pillow.readthedocs.io/en/stable/">Pillow</a>: Image processing library</p></li>
 <li><p><a class="reference external" href="https://github.com/wanadev/pyguetzli">PyGuetzli</a>: JPEG optimization</p></li>
-<li><p><a class="reference external" href="https://github.com/hattya/zopflipy">ZopfliPy</a>: PNG Optimization</p></li>
+<li><p><a class="reference external" href="https://github.com/hattya/zopflipy">ZopfliPy</a>: PNG optimization</p></li>
 </ul>
 <p>Development tools:</p>
 <ul class="simple">
@@ -327,6 +330,30 @@ optimization). If you want to run only specific tests, you can run them using
 </pre></div>
 </div>
 </section>
+<section id="updating-assimp">
+<h2>Updating ASSIMP<a class="headerlink" href="#updating-assimp" title="Link to this heading"></a></h2>
+<p>ASSIMP is the C++ library used by YOGA to manipulate 3D models. To update it,
+first check the latest version tag on the project’s repo :</p>
+<ul class="simple">
+<li><p><a class="reference external" href="https://github.com/assimp/assimp/tags">https://github.com/assimp/assimp/tags</a></p></li>
+</ul>
+<p>Then go to the assimp subfolder and checkout the latest release tag:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">assimp</span><span class="o">/</span>
+<span class="n">git</span> <span class="n">fetch</span>
+<span class="n">git</span> <span class="n">checkout</span> <span class="n">vX</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">Z</span>
+<span class="n">cd</span> <span class="o">..</span>
+</pre></div>
+</div>
+<p>Then, run tests to ensure YOGA still work:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">nox</span> <span class="o">-</span><span class="n">s</span> <span class="n">test</span>
+</pre></div>
+</div>
+<p>Finally, check we are still able to build a wheel from the sdist package:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">nox</span> <span class="o">-</span><span class="n">s</span> <span class="n">test_build_wheel</span>
+</pre></div>
+</div>
+<p>If the build fails because of a missing file, add it in <code class="docutils literal notranslate"><span class="pre">MANIFEST.in</span></code>.</p>
+</section>
 </section>
 
 

index.html

@@ -116,6 +116,7 @@ reference images, they are processed by YOGA’s image optimizer.</p>
 <li class="toctree-l2"><a class="reference internal" href="contributing.html#packaging-yoga">Packaging YOGA</a></li>
 <li class="toctree-l2"><a class="reference internal" href="contributing.html#developing-yoga">Developing YOGA</a></li>
 <li class="toctree-l2"><a class="reference internal" href="contributing.html#building-the-documentation">Building the Documentation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="contributing.html#updating-assimp">Updating ASSIMP</a></li>
 </ul>
 </li>
 </ul>