Skip to content

Commit

Permalink
docs: Minor additions
Browse files Browse the repository at this point in the history
  • Loading branch information
maestroque committed Jul 17, 2024
1 parent e61cf3d commit 2534b50
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 3 deletions.
4 changes: 1 addition & 3 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,5 @@ User guide
.. toctree::
:numbered:

user_guide/loading.rst
user_guide/processing.rst
user_guide/saving.rst
user_guide/metrics.rst
user_guide/exporting.rst
4 changes: 4 additions & 0 deletions docs/user_guide/exporting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. _usage_exporting:

Exporting physiological data metrics
------------------------------------
Empty file removed docs/user_guide/loading.rst
Empty file.
14 changes: 14 additions & 0 deletions docs/user_guide/metrics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _usage_metrics:

Computing physiological data metrics
------------------------------------

1. :ref:`_usage_metrics_physio`,

.. _usage_metrics_physio:

Using a Physio object
---------------------

Physiological data metrics can be easily computed using Physio objects, from :py:mod:`physutils`,
on which the physiological data will be loaded.
Empty file removed docs/user_guide/processing.rst
Empty file.
Empty file removed docs/user_guide/saving.rst
Empty file.

0 comments on commit 2534b50

Please sign in to comment.