aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorJ08nY2020-02-13 17:52:12 +0100
committerJ08nY2020-02-13 18:29:24 +0100
commiteef8b99dad6f43d97d9194a1a6f16bc5e2ef66b0 (patch)
tree8748dc624cc8047b9f1410b65ac0e6acf7df08eb /docs/index.rst
parentac0f153698adc4dfde4c8066d6052b916878f14a (diff)
downloadpyecsca-eef8b99dad6f43d97d9194a1a6f16bc5e2ef66b0.tar.gz
pyecsca-eef8b99dad6f43d97d9194a1a6f16bc5e2ef66b0.tar.zst
pyecsca-eef8b99dad6f43d97d9194a1a6f16bc5e2ef66b0.zip
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst15
1 files changed, 13 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 49bab42..d2e96f4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -5,7 +5,7 @@ pyecsca [pɪɛtska]
.. image:: https://img.shields.io/badge/-Github-brightgreen?style=flat&logo=github
:target: https://github.com/J08nY/pyecsca
.. image:: https://img.shields.io/travis/J08nY/pyecsca
- :target: https://travis-ci.org/J08nY/pyecsca
+ :target: https://travis-ci.com/J08nY/pyecsca
.. image:: https://img.shields.io/github/license/J08nY/pyecsca.svg
:target: https://github.com/J08nY/pyecsca/blob/master/LICENSE
.. image:: https://codecov.io/gh/J08nY/pyecsca/branch/master/graph/badge.svg
@@ -29,6 +29,15 @@ API
api/modules
+Notebooks
+=========
+
+.. toctree::
+ :titlesonly:
+ :maxdepth: 3
+
+ notebook/configuration_space
+
Requirements
============
@@ -56,7 +65,7 @@ Testing
- nose2_
- green_
- mypy_
- - flake8
+ - flake8_
- coverage_
Docs
@@ -64,6 +73,7 @@ Docs
- sphinx_
- sphinx-autodoc-typehints_
+ - nbsphinx_
License
=======
@@ -109,5 +119,6 @@ this support is very appreciated.
.. _coverage: https://coverage.readthedocs.io/
.. _sphinx: https://www.sphinx-doc.org/
.. _sphinx-autodoc-typehints: https://pypi.org/project/sphinx-autodoc-typehints/
+.. _nbsphinx: https://nbsphinx.readthedocs.io/
.. _Explicit-Formulas Database: https://www.hyperelliptic.org/EFD/index.html
.. _Riscure: https://www.riscure.com/