Merge pull request #45 from corriporai/develop

DOC: Updates DOCS for release 4.1
corriporai · May 29, 2021 · 52de344 · 52de344
2 parents 47c77bd + 6d66325
commit 52de344
Show file tree

Hide file tree

Showing 17 changed files with 58,285 additions and 15 deletions.
diff --git a/.github/workflows/readthedocs.yml b/.github/workflows/readthedocs.yml
@@ -20,8 +20,6 @@ jobs:
         uses: actions/setup-python@v1
         with:
           python-version: 3.7
-          PANDAS: "0.25"
-          NUMPY: "1.17"
 
       - name: Install required packages
         run: |

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -8,4 +8,5 @@ For full details see the commit logs at https://github.com/corriporai/runpandas.
 .. include:: docs/source/whatsnew/v0.1.0.txt
 .. include:: docs/source/whatsnew/v0.2.0.txt
 .. include:: docs/source/whatsnew/v0.3.0.txt
-.. include:: docs/source/whatsnew/v0.4.0.txt
+.. include:: docs/source/whatsnew/v0.4.0.txt
+.. include:: docs/source/whatsnew/v0.4.1.txt
diff --git a/README.rst b/README.rst
@@ -15,8 +15,8 @@ RunPandas - Python Package for handing running data from GPS-enabled tracking de
    :target: https://www.codefactor.io/repository/github/corriporai/runpandas
    :alt: CodeFactor
 
-.. image:: https://travis-ci.com/corriporai/runpandas.svg?branch=master
-    :target: https://travis-ci.com/github/corriporai/runpandas
+.. image:: https://github.com/corriporai/runpandas/workflows/Build/badge.svg?branch=master
+    :target: https://github.com/corriporai/runpandas/actions/workflows/build.yml
 
 .. image:: https://coveralls.io/repos/github/corriporai/runpandas/badge.svg?branch=master
     :target: https://coveralls.io/github/corriporai/runpandas
@@ -90,6 +90,14 @@ Install latest release version via pip
 
    $ pip install runpandas
 
+Install latest release version via conda
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: shell
+
+   $ conda install -c marcelcaraciolo runpandas
+
+
 Install latest development version
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/source/_version.txt b/docs/source/_version.txt
@@ -1 +1 @@
-Version: **0.2.0 (+52, 2dfa56e)** Date: **April 23, 2021**
+Version: **0.4.0 (+14, 58212c0)** Date: **May 28, 2021**
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -26,6 +26,12 @@ Install ``runpandas`` with:
 
   pip install runpandas
 
+or with:
+
+.. code-block:: bash
+
+  conda install -c marcelcaraciolo runpandas
+
 RunPandas depends on the following packages:
 
 - ``pandas``

diff --git a/docs/source/reference/acessors.rst b/docs/source/reference/acessors.rst
@@ -25,4 +25,6 @@ Metrics
    metrics.MetricsAcessor.distance
    metrics.MetricsAcessor.vertical_speed
    metrics.MetricsAcessor.gradient
-   metrics.MetricsAcessor.pace
+   metrics.MetricsAcessor.pace
+   metrics.MetricsAcessor.heart_zone
+   metrics.MetricsAcessor.time_in_zone
diff --git a/...ce/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.heart_zone.rst b/...ce/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.heart_zone.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.metrics.MetricsAcessor.heart\_zone
+===========================================================
+
+.. currentmodule:: runpandas.types.acessors.metrics
+
+.. automethod:: MetricsAcessor.heart_zone
diff --git a/docs/source/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.rst b/docs/source/reference/api/runpandas.types.acessors.metrics.MetricsAcessor.rst
@@ -16,8 +16,10 @@ runpandas.types.acessors.metrics.MetricsAcessor
       ~MetricsAcessor.__init__
       ~MetricsAcessor.distance
       ~MetricsAcessor.gradient
+      ~MetricsAcessor.heart_zone
       ~MetricsAcessor.pace
       ~MetricsAcessor.speed
+      ~MetricsAcessor.time_in_zone
       ~MetricsAcessor.vertical_speed
 
 

diff --git a/.../reference/api/runpandas.types.acessors.metrics.MetricsAcessor.time_in_zone.rst b/.../reference/api/runpandas.types.acessors.metrics.MetricsAcessor.time_in_zone.rst
@@ -0,0 +1,6 @@
+runpandas.types.acessors.metrics.MetricsAcessor.time\_in\_zone
+==============================================================
+
+.. currentmodule:: runpandas.types.acessors.metrics
+
+.. automethod:: MetricsAcessor.time_in_zone