Documentation improvements.

fraunhoferportugal · Jan 6, 2022 · dc4f6be · dc4f6be
1 parent 43a5cf8
commit dc4f6be
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -67,6 +67,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+Makefile
 
 # PyBuilder
 target/

diff --git a/LICENSE → LICENSE.txt b/LICENSE → LICENSE.txt
@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2021, Associação Fraunhofer Portugal Research
+Copyright (c) 2022, Associação Fraunhofer Portugal Research
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,2 @@
+.. _changelog:
+.. include:: ../CHANGELOG.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -61,7 +61,7 @@
 import datetime
 now = datetime.datetime.today()
 project = u'TSSEARCH'
-copyright = u'2021, Fraunhofer AICOS'
+copyright = u'2022, Fraunhofer AICOS'
 author = u'Fraunhofer AICOS'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/descriptions/elastic_distances.rst b/docs/descriptions/elastic_distances.rst
@@ -0,0 +1,5 @@
+=================
+Elastic Distances
+=================
+
+In development
diff --git a/docs/descriptions/lockstep_distances.rst b/docs/descriptions/lockstep_distances.rst
@@ -0,0 +1,6 @@
+==================
+Lockstep Distances
+==================
+
+Distance measures that compare the :math:`i`-th point of one time series to the :math:`i`-th point of another are named as lock-step measures (e.g., Euclidean distance and the other Lp norms).
+A linear interpolation is computed to the longer series to ensure it has the same length as the shorter series.
diff --git a/docs/imgs/fhp_logo.png b/docs/imgs/fhp_logo.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
-Welcome to TSFRESH documentation!
-===============================
+Welcome to TSSEARCH documentation!
+==================================
 
 Time Series Subsequence Search Python package (TSSEARCH for short) is a Python package that assists researchers in exploratory analysis for query search and time series segmentation without requiring significant programming effort. It contains curated routines for query and subsequence search. TSSEARCH installation is straightforward and goes along with startup code examples. Our goal is to provide the tools to get faster insights for your time series.
 
@@ -17,6 +17,15 @@ Contents
 
 In development
 
+.. toctree::
+   :maxdepth: 2
+
+   Lockstep Distances <descriptions/lockstep_distances>
+   Elastic Distances <descriptions/elastic_distances>
+   Authors <authors>
+   Changelog <changelog>
+   License <license>
+
 Installation
 ============
 

diff --git a/docs/license.rst b/docs/license.rst
@@ -0,0 +1,7 @@
+.. _license:
+
+=======
+License
+=======
+
+.. literalinclude:: ../LICENSE.txt