[ci skip] DOC add mention of pre-commit a784506

Author: glemaitre

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f4ed13ed34cc7b1f69ceaf744249b8b8
+config: 0ce5cfc3128298ad3a1c530d86a4235a
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip

@@ -110,7 +110,7 @@ Use scikit-learn to display the decision boundary
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.136 seconds)
+   **Total running time of the script:** (0 minutes 0.137 seconds)
 
 
 .. _sphx_glr_download_auto_examples_plot_classifier.py:

_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip

@@ -63,7 +63,7 @@ An example plot of :class:`skltemplate.template.TemplateTransformer`
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.063 seconds)
+   **Total running time of the script:** (0 minutes 0.061 seconds)
 
 
 .. _sphx_glr_download_auto_examples_plot_transformer.py:

_sources/auto_examples/plot_classifier.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.275** total execution time for 3 files **from auto_examples**:
+**00:00.273** total execution time for 3 files **from auto_examples**:
 
 .. container::
 
@@ -33,11 +33,11 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_auto_examples_plot_classifier.py` (``plot_classifier.py``)
-     - 00:00.136
+     - 00:00.137
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_template.py` (``plot_template.py``)
      - 00:00.075
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_transformer.py` (``plot_transformer.py``)
-     - 00:00.063
+     - 00:00.061
      - 0.0

_sources/auto_examples/plot_transformer.rst.txt

@@ -134,6 +134,30 @@ In addition, you have a linter task to check the code consistency in terms of st
 
   pixi run lint
 
+Activating the development environment
+--------------------------------------
+
+In the case that you don't want to use the `pixi run` commands and directly interact
+with the usual python tools, you can activate the development environment:
+
+.. prompt:: bash $
+
+  pixi shell -e dev
+
+This will activate an environment containing the dependencies needed to run the linters,
+tests, and build the documentation. So for instance, you can run the tests with:
+
+.. prompt:: bash $
+
+  pytest -vsl skltemplate
+
+In this case, you can even use pre-commit before using git. You will need to initialize
+it with:
+
+.. prompt:: bash $
+
+  pre-commit install
+
 Setup the continuous integration
 --------------------------------
 

_sources/auto_examples/sg_execution_times.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.275** total execution time for 3 files **from all galleries**:
+**00:00.273** total execution time for 3 files **from all galleries**:
 
 .. container::
 
@@ -33,11 +33,11 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_auto_examples_plot_classifier.py` (``../examples/plot_classifier.py``)
-     - 00:00.136
+     - 00:00.137
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_template.py` (``../examples/plot_template.py``)
      - 00:00.075
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_transformer.py` (``../examples/plot_transformer.py``)
-     - 00:00.063
+     - 00:00.061
      - 0.0

_sources/quick_start.rst.txt

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.2.dev1+g939dd4e',
+    VERSION: '0.1.2.dev3+ga784506',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

_sources/sg_execution_times.rst.txt

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>API Reference &#8212; Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation</title>
+    <title>API Reference &#8212; Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation</title>
 
 
 
@@ -42,7 +42,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="_static/documentation_options.js?v=8d1d479a"></script>
+    <script src="_static/documentation_options.js?v=4262caba"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=36754332"></script>
@@ -127,8 +127,8 @@
 
 
 
-    <img src="_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>
-    <script>document.write(`<img src="_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>`);</script>
+    <img src="_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>
+    <script>document.write(`<img src="_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>`);</script>
 
 
 </a></div>