Skip to content

Commit d53f99c

Browse files
dirty-cat-cidirty-cat-ci
committed
Pushing the docs to 0.5/ for branch: 0.5.X, commit 403db7db249178a7dfc4dbc8d7dbd98f2b023e16
1 parent 39d81de commit d53f99c

724 files changed

Lines changed: 27232 additions & 21083 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎0.5/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 90508dcaed895a250a87f0fe40f5ff61
3+
config: 6ba93e5857535957d27fe5189667554c
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎0.5/CHANGES.html‎

Lines changed: 120 additions & 102 deletions
Large diffs are not rendered by default.

‎0.5/CONTRIBUTING.html‎

Lines changed: 14 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
4242
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
4343
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
44-
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=2c9f8f05" />
44+
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=8ee2c72c" />
4545
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
4646
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
4747
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
@@ -54,7 +54,7 @@
5454
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
5555
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
5656

57-
<script src="_static/documentation_options.js?v=2a2fe768"></script>
57+
<script src="_static/documentation_options.js?v=e1a677a5"></script>
5858
<script src="_static/doctools.js?v=9bcbadda"></script>
5959
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
6060
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -64,7 +64,7 @@
6464
<script>
6565
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
6666
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/skrub-data/skrub/main/doc/version.json';
67-
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.3';
67+
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.4';
6868
DOCUMENTATION_OPTIONS.show_version_warning_banner =
6969
true;
7070
</script>
@@ -75,7 +75,7 @@
7575
<link rel="prev" title="About" href="about.html" />
7676
<meta name="viewport" content="width=device-width, initial-scale=1"/>
7777
<meta name="docsearch:language" content="en"/>
78-
<meta name="docsearch:version" content="0.5.3" />
78+
<meta name="docsearch:version" content="0.5.4" />
7979
</head>
8080

8181

@@ -682,39 +682,14 @@ <h4>Preparing the ground<a class="headerlink" href="#preparing-the-ground" title
682682
</section>
683683
<section id="setting-up-the-environment">
684684
<h4>Setting up the environment<a class="headerlink" href="#setting-up-the-environment" title="Link to this heading">#</a></h4>
685-
<p>To contribute, you will first have to run through some steps:</p>
686-
<ul class="simple">
687-
<li><p>Set up your environment by forking the repository (<a class="reference external" href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo">Github doc on
688-
forking and
689-
cloning</a>).</p></li>
690-
<li><p>Create and activate a new virtual environment:</p>
691-
<ul>
692-
<li><p>With <a class="reference external" href="https://docs.python.org/3/library/venv.html">venv</a>, create
693-
the env with <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">venv</span> <span class="pre">env_skrub</span></code> and then activate it with
694-
<code class="docutils literal notranslate"><span class="pre">source</span> <span class="pre">env_skrub/bin/activate</span></code>.</p></li>
695-
<li><p>With
696-
<a class="reference external" href="https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html">conda</a>,
697-
create the env with <code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">new</span> <span class="pre">-n</span> <span class="pre">env_skrub</span></code> and activate it with
698-
<code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">activate</span> <span class="pre">env_skrub</span></code>.</p></li>
699-
<li><p>While at the root of your local copy of skrub and within the new
700-
env, install the required development dependencies by running
701-
<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">--editable</span> <span class="pre">&quot;.[dev,</span> <span class="pre">lint,</span> <span class="pre">test,</span> <span class="pre">doc]&quot;</span></code>.</p></li>
702-
</ul>
703-
</li>
704-
<li><p>Run <code class="docutils literal notranslate"><span class="pre">pre-commit</span> <span class="pre">install</span></code> to activate some checks that will run every
705-
time you do a <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span></code> (mostly, formatting checks).</p></li>
706-
</ul>
707-
<p>If you want to make sure that everything runs properly, you can run all
708-
the tests with the command <code class="docutils literal notranslate"><span class="pre">pytest</span> <span class="pre">-s</span> <span class="pre">skrub/tests</span></code>; note that this may
709-
take a long time. Some tests may raise warnings such as:</p>
710-
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>UserWarning:<span class="w"> </span>Only<span class="w"> </span>pandas<span class="w"> </span>and<span class="w"> </span>polars<span class="w"> </span>DataFrames<span class="w"> </span>are<span class="w"> </span>supported,<span class="w"> </span>but<span class="w"> </span>input<span class="w"> </span>is<span class="w"> </span>a<span class="w"> </span>Numpy<span class="w"> </span>array.<span class="w"> </span>Please<span class="w"> </span>convert<span class="w"> </span>Numpy<span class="w"> </span>arrays<span class="w"> </span>to<span class="w"> </span>DataFrames<span class="w"> </span>before<span class="w"> </span>passing<span class="w"> </span>them<span class="w"> </span>to<span class="w"> </span>skrub<span class="w"> </span>transformers.<span class="w"> </span>Converting<span class="w"> </span>to<span class="w"> </span>pandas<span class="w"> </span>DataFrame<span class="w"> </span>with<span class="w"> </span>columns<span class="w"> </span><span class="o">[</span><span class="s1">&#39;0&#39;</span>,<span class="w"> </span><span class="s1">&#39;1&#39;</span>,<span class="w"> </span>…<span class="o">]</span>.
711-
<span class="w"> </span>warnings.warn<span class="o">(</span>
712-
</pre></div>
713-
</div>
714-
<p>This is expected, and you may proceed with the next steps without worrying about them. However, no tests should fail at this point: if they do fail, then let us know.</p>
715-
<p>Now that the development environment is ready, you may start working on
716-
the new issue by creating a new branch:</p>
717-
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>my-branch-name-eg-fix-issue-123
685+
<p>To setup your development environment, you need to follow the steps in “From Source” tab
686+
present in <a class="reference internal" href="install.html#installing-from-source"><span class="std std-ref">Installing from source</span></a> page.
687+
After that, you can return to this page to continue.</p>
688+
<p>Now that the development environment is ready, you may create a new branch and start working on
689+
the new issue.</p>
690+
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># fetch latest updates and start from the current head</span>
691+
git<span class="w"> </span>fetch<span class="w"> </span>upstream
692+
git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>my-branch-name-eg-fix-issue-123
718693
<span class="c1"># make some changes</span>
719694
git<span class="w"> </span>add<span class="w"> </span>./the/file-i-changed
720695
git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;my message&quot;</span>
@@ -776,7 +751,7 @@ <h3>Testing the code<a class="headerlink" href="#testing-the-code" title="Link t
776751
<code class="docutils literal notranslate"><span class="pre">skrub/_dataframe/tests/test_common.py</span></code> to add a test for the
777752
<code class="docutils literal notranslate"><span class="pre">amazing_function</span></code>.</p>
778753
<p>Run each updated test file using <code class="docutils literal notranslate"><span class="pre">pytest</span></code>
779-
([pytest docs](<a class="reference external" href="https://docs.pytest.org/en/stable/">https://docs.pytest.org/en/stable/</a>)):</p>
754+
(<a class="reference external" href="https://docs.pytest.org/en/stable">pytest docs</a>):</p>
780755
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pytest<span class="w"> </span>-vsl<span class="w"> </span>skrub/tests/test_amazing_transformer.py<span class="w"> </span><span class="se">\</span>
781756
skrub/_dataframe/tests/test_common.py<span class="w"> </span><span class="se">\</span>
782757
skrub/_dataframe/tests/test_table_vectorizer.py
@@ -913,11 +888,6 @@ <h2>Building the documentation<a class="headerlink" href="#building-the-document
913888
and addressing any issues.</strong></p>
914889
<p>First, make sure you have properly installed the development version of skrub.
915890
You can follow the <a class="reference internal" href="install.html#installation-instructions"><span class="std std-ref">Install</span></a> &gt; “From source” section, if needed.</p>
916-
<p>Building the documentation requires installing some additional packages:</p>
917-
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>skrub
918-
pip<span class="w"> </span>install<span class="w"> </span><span class="s1">&#39;.[doc]&#39;</span>
919-
</pre></div>
920-
</div>
921891
<p>To build the documentation, you need to be in the <code class="docutils literal notranslate"><span class="pre">doc</span></code> folder:</p>
922892
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>doc
923893
</pre></div>
@@ -1058,7 +1028,7 @@ <h3>This Page</h3>
10581028
<div class="footer-item">
10591029

10601030
<p class="sphinx-version">
1061-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
1031+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
10621032
<br/>
10631033
</p>
10641034
</div>

‎0.5/RELEASE_PROCESS.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
4242
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
4343
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
44-
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=2c9f8f05" />
44+
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=8ee2c72c" />
4545
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
4646
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
4747
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
@@ -54,7 +54,7 @@
5454
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
5555
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
5656

57-
<script src="_static/documentation_options.js?v=2a2fe768"></script>
57+
<script src="_static/documentation_options.js?v=e1a677a5"></script>
5858
<script src="_static/doctools.js?v=9bcbadda"></script>
5959
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
6060
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -64,7 +64,7 @@
6464
<script>
6565
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
6666
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/skrub-data/skrub/main/doc/version.json';
67-
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.3';
67+
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.4';
6868
DOCUMENTATION_OPTIONS.show_version_warning_banner =
6969
true;
7070
</script>
@@ -74,7 +74,7 @@
7474
<link rel="search" title="Search" href="search.html" />
7575
<meta name="viewport" content="width=device-width, initial-scale=1"/>
7676
<meta name="docsearch:language" content="en"/>
77-
<meta name="docsearch:version" content="0.5.3" />
77+
<meta name="docsearch:version" content="0.5.4" />
7878
</head>
7979

8080

@@ -714,7 +714,7 @@ <h3>This Page</h3>
714714
<div class="footer-item">
715715

716716
<p class="sphinx-version">
717-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
717+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
718718
<br/>
719719
</p>
720720
</div>

‎0.5/_downloads/0489157882e9236e99043be54168dbb0/00_getting_started.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@
253253
"name": "python",
254254
"nbconvert_exporter": "python",
255255
"pygments_lexer": "ipython3",
256-
"version": "3.12.8"
256+
"version": "3.12.11"
257257
}
258258
},
259259
"nbformat": 4,

‎0.5/_downloads/174a42f7d0559f495def2979035e97aa/09_interpolation_join.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@
283283
"name": "python",
284284
"nbconvert_exporter": "python",
285285
"pygments_lexer": "ipython3",
286-
"version": "3.12.8"
286+
"version": "3.12.11"
287287
}
288288
},
289289
"nbformat": 4,

‎0.5/_downloads/1beb4a6828e42ba7f09ae925e26e794b/02_text_with_string_encoders.zip‎

1 Byte
Binary file not shown.

‎0.5/_downloads/1edecd3a067d076f9dde43db0a6ad2ac/00_getting_started.zip‎

1 Byte
Binary file not shown.

‎0.5/_downloads/28079b3b8fa6a36780f883fc70c5a85b/01_encodings.zip‎

1 Byte
Binary file not shown.

‎0.5/_downloads/32eb7122d28304b1f0e44f3a61f9889b/02_text_with_string_encoders.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@
193193
"name": "python",
194194
"nbconvert_exporter": "python",
195195
"pygments_lexer": "ipython3",
196-
"version": "3.12.8"
196+
"version": "3.12.11"
197197
}
198198
},
199199
"nbformat": 4,

0 commit comments

Comments
 (0)