aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorJ08nY2018-12-08 15:38:14 +0100
committerJ08nY2019-03-14 18:03:59 +0100
commit926e598786197d546a0eae1eeb1d06f341b6cd2e (patch)
tree330c4f8521559b8e34df4137480490bf2eb2feb3 /docs/index.rst
parente0a6e7c452cd55365096bc3e4b8f36f5f9660ae7 (diff)
downloadpyecsca-926e598786197d546a0eae1eeb1d06f341b6cd2e.tar.gz
pyecsca-926e598786197d546a0eae1eeb1d06f341b6cd2e.tar.zst
pyecsca-926e598786197d546a0eae1eeb1d06f341b6cd2e.zip
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..0e51a6d
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,51 @@
+.. pyecsca documentation master file, created by
+ sphinx-quickstart on Sat Dec 8 15:12:50 2018.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+=================
+pyecsca [pɪɛtska]
+=================
+
+**Py**\ thon **EC** **S**\ ide-**C**\ hannel **A**\ nalysis toolkit.
+
+Requirements
+============
+
+ - Numpy_
+ - Scipy_
+ - matplotlib_
+ - atpublic_
+ - fastdtw_
+
+Testing
+-------
+
+ - nose2
+ - green
+
+Docs
+----
+
+ - sphinx
+
+API
+===
+
+.. toctree::
+ api/pyecsca
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+.. _Numpy: https://www.numpy.org
+.. _Scipy: https://www.scipy.org
+.. _matplotlib: https://matplotlib.org/
+.. _atpublic: https://public.readthedocs.io/
+.. _fastdtw: https://github.com/slaypni/fastdtw \ No newline at end of file