Skip to content

Commit aa78270

Browse files
solegallisolegalli
authored
expose variable handling functions in documentation (#611)
* expand docstring * refactor module variable handling * refactor variable names * add functions to api * add functions to docs api * add user guide base rst files and index * reduce maxdepth toctree to 1 * fix import * add user guide examples * final doc adjustments
1 parent a072085 commit aa78270

File tree

77 files changed

+1123
-363
lines changed

Some content is hidden

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

77 files changed

+1123
-363
lines changed

‎docs/api_doc/datetime/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Feature-engine's datetime transformers are able to extract a wide variety of dat
77
features from existing datetime or object-like data.
88

99
.. toctree::
10-
:maxdepth: 2
10+
:maxdepth: 1
1111

1212
DatetimeFeatures
1313

‎docs/api_doc/discretisation/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ into continuous intervals.
2222

2323

2424
.. toctree::
25-
:maxdepth: 2
25+
:maxdepth: 1
2626
:hidden:
2727

2828
EqualFrequencyDiscretiser

‎docs/api_doc/imputation/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ categorical variables by nature are coded as numeric.
3030

3131

3232
.. toctree::
33-
:maxdepth: 2
33+
:maxdepth: 1
3434
:hidden:
3535

3636
MeanMedianImputer

‎docs/api_doc/index.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,11 @@ Other
5050

5151
preprocessing/index
5252
wrappers/index
53+
54+
55+
Tools
56+
-----
57+
.. toctree::
58+
:maxdepth: 1
59+
60+
variable_handling/index

‎docs/api_doc/outliers/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ arbitrary or derived value. The OutlierTrimmer removes outliers from the dataset
1717
=================================== ==============================================================
1818

1919
.. toctree::
20-
:maxdepth: 2
20+
:maxdepth: 1
2121
:hidden:
2222

2323
Winsorizer

‎docs/api_doc/selection/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Alternative feature selection methods
6363

6464

6565
.. toctree::
66-
:maxdepth: 2
66+
:maxdepth: 1
6767
:hidden:
6868

6969
DropFeatures

‎docs/api_doc/timeseries/forecasting/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ dataframe by lagging features or calculating statistics over windows of time in
88
past.
99

1010
.. toctree::
11-
:maxdepth: 2
11+
:maxdepth: 1
1212

1313
LagFeatures
1414
WindowFeatures

‎docs/api_doc/timeseries/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Time Series Features
66
Feature-engine's time series transformers derive features from time series data.
77

88
.. toctree::
9-
:maxdepth: 2
9+
:maxdepth: 1
1010

1111
forecasting/index
1212

‎docs/api_doc/transformation/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Feature-engine's variable transformers transform numerical variables with variou
77
mathematical transformations.
88

99
.. toctree::
10-
:maxdepth: 2
10+
:maxdepth: 1
1111

1212
LogTransformer
1313
LogCpTransformer

‎docs/api_doc/variable_handling/find_all_variables.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
find_all_variables
2+
==================
3+
4+
.. currentmodule:: feature_engine.variable_handling
5+
6+
.. autofunction:: find_all_variables

0 commit comments

Comments
 (0)