From 795711b481e53f25da82131a60ccbf14ff78481b Mon Sep 17 00:00:00 2001 From: Nils Braun Date: Wed, 22 Feb 2023 21:20:52 +0100 Subject: [PATCH] Update to newest sphinx api docs --- docs/api/modules.rst | 3 +- docs/api/tsfresh.convenience.rst | 40 ++++++++++------- docs/api/tsfresh.examples.rst | 48 ++++++++++++-------- docs/api/tsfresh.feature_extraction.rst | 56 ++++++++++++++--------- docs/api/tsfresh.feature_selection.rst | 48 +++++++++++--------- docs/api/tsfresh.rst | 44 ++++++++++++------ docs/api/tsfresh.scripts.rst | 35 +++++++++------ docs/api/tsfresh.transformers.rst | 60 ++++++++++++++----------- docs/api/tsfresh.utilities.rst | 60 ++++++++++++++----------- docs/conf.py | 2 +- 10 files changed, 235 insertions(+), 161 deletions(-) diff --git a/docs/api/modules.rst b/docs/api/modules.rst index 36d28c5ad..3724b557c 100644 --- a/docs/api/modules.rst +++ b/docs/api/modules.rst @@ -1,6 +1,5 @@ -Modules +tsfresh ======= -This is the content of the tsfresh package .. toctree:: :maxdepth: 4 diff --git a/docs/api/tsfresh.convenience.rst b/docs/api/tsfresh.convenience.rst index 2e3c83e79..956b3fb66 100644 --- a/docs/api/tsfresh.convenience.rst +++ b/docs/api/tsfresh.convenience.rst @@ -1,23 +1,29 @@ -convenience -=========== +tsfresh.convenience package +=========================== -.. automodule:: tsfresh.convenience - :members: - :undoc-members: - :show-inheritance: +Submodules +---------- + +tsfresh.convenience.bindings module +----------------------------------- + +.. automodule:: tsfresh.convenience.bindings + :members: + :undoc-members: + :show-inheritance: -relevant_extraction module --------------------------- +tsfresh.convenience.relevant\_extraction module +----------------------------------------------- .. automodule:: tsfresh.convenience.relevant_extraction - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -bindings module --------------------------- +Module contents +--------------- -.. automodule:: tsfresh.convenience.bindings - :members: - :undoc-members: - :show-inheritance: +.. automodule:: tsfresh.convenience + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/tsfresh.examples.rst b/docs/api/tsfresh.examples.rst index 5f3e8dc77..9ee8ac129 100644 --- a/docs/api/tsfresh.examples.rst +++ b/docs/api/tsfresh.examples.rst @@ -1,25 +1,37 @@ -examples -======== +tsfresh.examples package +======================== -.. automodule:: tsfresh.examples - :members: - :undoc-members: - :show-inheritance: +Submodules +---------- +tsfresh.examples.driftbif\_simulation module +-------------------------------------------- -robot_execution_failures ------------------------- +.. automodule:: tsfresh.examples.driftbif_simulation + :members: + :undoc-members: + :show-inheritance: -.. automodule:: tsfresh.examples.robot_execution_failures - :members: - :undoc-members: - :show-inheritance: +tsfresh.examples.har\_dataset module +------------------------------------ +.. automodule:: tsfresh.examples.har_dataset + :members: + :undoc-members: + :show-inheritance: -har_dataset ------------ +tsfresh.examples.robot\_execution\_failures module +-------------------------------------------------- -.. automodule:: tsfresh.examples.har_dataset - :members: - :undoc-members: - :show-inheritance: +.. automodule:: tsfresh.examples.robot_execution_failures + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tsfresh.examples + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/tsfresh.feature_extraction.rst b/docs/api/tsfresh.feature_extraction.rst index 0bb751887..a26722f2c 100644 --- a/docs/api/tsfresh.feature_extraction.rst +++ b/docs/api/tsfresh.feature_extraction.rst @@ -1,31 +1,45 @@ -feature_extraction -================== +tsfresh.feature\_extraction package +=================================== -.. automodule:: tsfresh.feature_extraction - :members: - :undoc-members: - :show-inheritance: - -extraction +Submodules ---------- +tsfresh.feature\_extraction.data module +--------------------------------------- + +.. automodule:: tsfresh.feature_extraction.data + :members: + :undoc-members: + :show-inheritance: + +tsfresh.feature\_extraction.extraction module +--------------------------------------------- + .. automodule:: tsfresh.feature_extraction.extraction - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -feature_calculators -------------------- +tsfresh.feature\_extraction.feature\_calculators module +------------------------------------------------------- .. automodule:: tsfresh.feature_extraction.feature_calculators - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -settings --------- +tsfresh.feature\_extraction.settings module +------------------------------------------- .. automodule:: tsfresh.feature_extraction.settings - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tsfresh.feature_extraction + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/tsfresh.feature_selection.rst b/docs/api/tsfresh.feature_selection.rst index f82f2c227..5697eae22 100644 --- a/docs/api/tsfresh.feature_selection.rst +++ b/docs/api/tsfresh.feature_selection.rst @@ -1,31 +1,37 @@ -feature_selection -================= +tsfresh.feature\_selection package +================================== -.. automodule:: tsfresh.feature_selection - :members: - :undoc-members: - :show-inheritance: +Submodules +---------- -relevance ---------- +tsfresh.feature\_selection.relevance module +------------------------------------------- .. automodule:: tsfresh.feature_selection.relevance - :members: - :undoc-members: _calculate_relevance_table_for_implicit_target - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -selection ---------- +tsfresh.feature\_selection.selection module +------------------------------------------- .. automodule:: tsfresh.feature_selection.selection - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -significance_tests ------------------- +tsfresh.feature\_selection.significance\_tests module +----------------------------------------------------- .. automodule:: tsfresh.feature_selection.significance_tests - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tsfresh.feature_selection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/tsfresh.rst b/docs/api/tsfresh.rst index a1c2900c5..e70aca210 100644 --- a/docs/api/tsfresh.rst +++ b/docs/api/tsfresh.rst @@ -1,17 +1,35 @@ -API documentation -================= +tsfresh package +=============== -.. automodule:: tsfresh - :members: - :undoc-members: - :show-inheritance: +Subpackages +----------- .. toctree:: + :maxdepth: 4 + + tsfresh.convenience + tsfresh.examples + tsfresh.feature_extraction + tsfresh.feature_selection + tsfresh.scripts + tsfresh.transformers + tsfresh.utilities + +Submodules +---------- + +tsfresh.defaults module +----------------------- - tsfresh.convenience - tsfresh.feature_extraction - tsfresh.feature_selection - tsfresh.examples - tsfresh.scripts - tsfresh.transformers - tsfresh.utilities +.. automodule:: tsfresh.defaults + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tsfresh + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/tsfresh.scripts.rst b/docs/api/tsfresh.scripts.rst index f6b2ae297..8291ddc08 100644 --- a/docs/api/tsfresh.scripts.rst +++ b/docs/api/tsfresh.scripts.rst @@ -4,27 +4,34 @@ tsfresh.scripts package Submodules ---------- -tsfresh.scripts.run_tsfresh module ----------------------------------- +tsfresh.scripts.measure\_execution\_time module +----------------------------------------------- + +.. automodule:: tsfresh.scripts.measure_execution_time + :members: + :undoc-members: + :show-inheritance: + +tsfresh.scripts.run\_tsfresh module +----------------------------------- .. automodule:: tsfresh.scripts.run_tsfresh - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -tsfresh.scripts.test_timing module ----------------------------------- +tsfresh.scripts.test\_timing module +----------------------------------- .. automodule:: tsfresh.scripts.test_timing - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: tsfresh.scripts - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/tsfresh.transformers.rst b/docs/api/tsfresh.transformers.rst index f5706ca53..f5c27bce9 100644 --- a/docs/api/tsfresh.transformers.rst +++ b/docs/api/tsfresh.transformers.rst @@ -1,39 +1,45 @@ -transformers -============ +tsfresh.transformers package +============================ -.. automodule:: tsfresh.transformers - :members: - :undoc-members: - :show-inheritance: +Submodules +---------- -feature_augmenter ------------------ +tsfresh.transformers.feature\_augmenter module +---------------------------------------------- .. automodule:: tsfresh.transformers.feature_augmenter - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -feature_selector ----------------- +tsfresh.transformers.feature\_selector module +--------------------------------------------- .. automodule:: tsfresh.transformers.feature_selector - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + +tsfresh.transformers.per\_column\_imputer module +------------------------------------------------ + +.. automodule:: tsfresh.transformers.per_column_imputer + :members: + :undoc-members: + :show-inheritance: -relevant_feature_augmenter --------------------------- +tsfresh.transformers.relevant\_feature\_augmenter module +-------------------------------------------------------- .. automodule:: tsfresh.transformers.relevant_feature_augmenter - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -per_column_imputer --------------------------- +Module contents +--------------- -.. automodule:: tsfresh.transformers.per_column_imputer - :members: - :undoc-members: - :show-inheritance: +.. automodule:: tsfresh.transformers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/tsfresh.utilities.rst b/docs/api/tsfresh.utilities.rst index 9360253a3..5842f0d69 100644 --- a/docs/api/tsfresh.utilities.rst +++ b/docs/api/tsfresh.utilities.rst @@ -1,39 +1,45 @@ -utilities -========= +tsfresh.utilities package +========================= -.. automodule:: tsfresh.utilities - :members: - :undoc-members: - :show-inheritance: +Submodules +---------- -dataframe_functions -------------------- +tsfresh.utilities.dataframe\_functions module +--------------------------------------------- .. automodule:: tsfresh.utilities.dataframe_functions - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: + +tsfresh.utilities.distribution module +------------------------------------- + +.. automodule:: tsfresh.utilities.distribution + :members: + :undoc-members: + :show-inheritance: -profiling ---------- +tsfresh.utilities.profiling module +---------------------------------- .. automodule:: tsfresh.utilities.profiling - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -string_manipulation -------------------- +tsfresh.utilities.string\_manipulation module +--------------------------------------------- .. automodule:: tsfresh.utilities.string_manipulation - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -distribution ------------- +Module contents +--------------- -.. automodule:: tsfresh.utilities.distribution - :members: - :undoc-members: - :show-inheritance: +.. automodule:: tsfresh.utilities + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py index 4be23085f..eed7b4759 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,7 +37,7 @@ module_dir = os.path.join(__location__, "../tsfresh") cmd_line_template = "sphinx-apidoc -f -o {outputdir} {moduledir}" cmd_line = cmd_line_template.format(outputdir=output_dir, moduledir=module_dir) - main(cmd_line.split(" ")) + main(cmd_line.split(" ")[1:]) # -- General configuration -----------------------------------------------------