remove intermediary folders (#1123)

skrub-data · Oct 28, 2024 · 4a6f154 · 4a6f154
1 parent d418554
commit 4a6f154
Show file tree

Hide file tree

Showing 7 changed files with 133 additions and 135 deletions.
diff --git a/doc/reference/building_a_pipeline.rst b/doc/reference/building_a_pipeline.rst
diff --git a/doc/reference/cleaning_a_dataframe.rst b/doc/reference/cleaning_a_dataframe.rst
diff --git a/doc/reference/downloading_a_dataset.rst b/doc/reference/downloading_a_dataset.rst
diff --git a/doc/reference/encoding_a_column.rst b/doc/reference/encoding_a_column.rst
diff --git a/doc/reference/generating_a_report.rst b/doc/reference/generating_a_report.rst
diff --git a/doc/reference/index.rst b/doc/reference/index.rst
@@ -1,15 +1,140 @@
+.. currentmodule:: skrub
+
 ###
 API
 ###
 
 This page lists all available functions and classes of `skrub`.
 
-.. toctree::
-   :maxdepth: 2
+.. _joining_dataframes_ref:
+
+Joining dataframes
+==================
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
+
+   Joiner
+   AggJoiner
+   MultiAggJoiner
+   AggTarget
+   InterpolationJoiner
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
+
+   fuzzy_join
+
+
+.. _encoding_a_column_ref:
+
+Encoding a column
+=================
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
+
+   GapEncoder
+   MinHashEncoder
+   SimilarityEncoder
+   DatetimeEncoder
+   ToCategorical
+   ToDatetime
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
+
+   to_datetime
+
+
+.. _building_a_pipeline_ref:
+
+Building a pipeline
+===================
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
+
+   TableVectorizer
+   SelectCols
+   DropCols
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
+
+   tabular_learner
+
+
+.. _generating_a_report_ref:
+
+Generating an HTML report
+=========================
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
+
+   TableReport
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
+
+   patch_display
+   unpatch_display
+   column_associations
+
+
+.. _cleaning_a_dataframe_ref:
+
+Cleaning a dataframe
+====================
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
+
+   deduplicate
+
+
+.. _downloading_a_dataset_ref:
+
+.. currentmodule:: skrub.datasets
+
+Downloading a dataset
+=====================
+
+.. autosummary::
+   :toctree: generated/
+   :template: base.rst
+   :nosignatures:
 
-   joining_dataframes
-   encoding_a_column
-   building_a_pipeline
-   generating_a_report
-   cleaning_a_dataframe
-   downloading_a_dataset
+   fetch_employee_salaries
+   fetch_medical_charge
+   fetch_midwest_survey
+   fetch_open_payments
+   fetch_road_safety
+   fetch_traffic_violations
+   fetch_drug_directory
+   fetch_world_bank_indicator
+   fetch_movielens
+   fetch_credit_fraud
+   fetch_ken_table_aliases
+   fetch_ken_types
+   fetch_ken_embeddings
+   make_deduplication_data
diff --git a/doc/reference/joining_dataframes.rst b/doc/reference/joining_dataframes.rst