Add some fixes for the review (#9)

* Add fixes for the first review
* fix deploy-test

.github/workflows/deploy-test.yml

@@ -2,10 +2,8 @@ name: Deploy to TestPyPi
 
 on:
   push:
-    branches:
-    - '**'        # run for all branches
     branches-ignore:
-    - 'master'    # except master
+    - 'master'
 
 jobs:
     build-n-publish-testing:

.readthedocs.yaml

@@ -0,0 +1,11 @@
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+python:
+  install:
+    - method: pip
+      path: .

CONTRIBUTING.rst

@@ -109,6 +109,11 @@ To run a subset of tests::
 
     $ py.test tests.test_jointly
 
+
+To run all tests::
+
+    $ py.test tests.test_jointly
+
 Deploying
 ---------
 

HISTORY.rst

@@ -2,6 +2,14 @@
 History
 =======
 
+1.0.3 (2021-12-09)
+------------------
+
+* remove poetry-core version dependency
+* add information on running all tests to CONTRIBUTING.rst
+* add a statement of need
+* add documentation deep links to README.rst
+* hopefully fix RTD build
 
 1.0.2 (2021-08-04)
 ------------------

README.rst

@@ -28,6 +28,7 @@ jointly readme
 
 
 jointly is a python package for synchronizing sensors with accelerometer data.
+You need this package if you're a researcher who has recorded accelerometer data (plus possibly other data) on multiple sensors and want to precisely synchronize the multiple data streams.
 Specifically, shake all your sensors in a box before and after a trial, and jointly will find these shakes, remove any temporal offset between sensors, and stretch the data so every clock aligns to a reference sensor.
 Jointly ingests and produces ``pandas``' ``DataFrame`` objects.
 
@@ -125,6 +126,18 @@ in the ``DataFrame`` will be synchronized together with that column.
     with tempfile.TemporaryDirectory() as tmp_dir:
         synchronizer.save_pickles(tmp_dir)
 
+Documentation Deep Links
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Here you can find more information on specific topics:
+
+* `Preparing Data for Ingestion`_
+* `Tuning the Shake Detection`_
+* `Debugging the Shake Detection`_
+* `How to Save the Synchronized Data`_
+* `How to Enable Logging`_
+* `Full Explanation of the Synchronization`_
+
 Template Credits
 ----------------
 
@@ -133,3 +146,9 @@ This package was created with Cookiecutter_ and the `pyOpenSci/cookiecutter-pyop
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 .. _`pyOpenSci/cookiecutter-pyopensci`: https://github.com/pyOpenSci/cookiecutter-pyopensci
 .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
+.. _`Preparing Data for Ingestion`: https://jointly.readthedocs.io/en/latest/usage.html#preparing-data-for-ingestion
+.. _`Tuning the Shake Detection`: https://jointly.readthedocs.io/en/latest/usage.html#tuning-shake-detection
+.. _`Debugging the Shake Detection`: https://jointly.readthedocs.io/en/latest/usage.html#debugging
+.. _`How to Save the Synchronized Data`: https://jointly.readthedocs.io/en/latest/usage.html#saving-data
+.. _`How to Enable Logging`: https://jointly.readthedocs.io/en/latest/usage.html#logging
+.. _`Full Explanation of the Synchronization`: https://jointly.readthedocs.io/en/latest/background.html#the-syncing-process

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "jointly"
-version = "1.0.2"
+version = "1.0.3"
 description = "Synchronize sensor data from accelerometer shakes"
 authors = [
     "Ariane Morassi Sasso <ariane.morassi-sasso@hpi.de>",
@@ -47,5 +47,5 @@ pyproject-flake8 = "^0.0.1-alpha.2"
 pyarrow = "^5.0.0"
 
 [build-system]
-requires = ["poetry-core>=1.2.0"]
+requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"