Skip to content

Commit

Permalink
Update to newest sphinx api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nils-braun committed Feb 22, 2023
1 parent 62414a6 commit 795711b
Show file tree
Hide file tree
Showing 10 changed files with 235 additions and 161 deletions.
3 changes: 1 addition & 2 deletions docs/api/modules.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
Modules
tsfresh
=======
This is the content of the tsfresh package

.. toctree::
:maxdepth: 4
Expand Down
40 changes: 23 additions & 17 deletions docs/api/tsfresh.convenience.rst
Original file line number Diff line number Diff line change
@@ -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:
48 changes: 30 additions & 18 deletions docs/api/tsfresh.examples.rst
Original file line number Diff line number Diff line change
@@ -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:
56 changes: 35 additions & 21 deletions docs/api/tsfresh.feature_extraction.rst
Original file line number Diff line number Diff line change
@@ -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:
48 changes: 27 additions & 21 deletions docs/api/tsfresh.feature_selection.rst
Original file line number Diff line number Diff line change
@@ -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:
44 changes: 31 additions & 13 deletions docs/api/tsfresh.rst
Original file line number Diff line number Diff line change
@@ -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:
35 changes: 21 additions & 14 deletions docs/api/tsfresh.scripts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Loading

0 comments on commit 795711b

Please sign in to comment.