diff options
| author | J08nY | 2020-02-13 17:52:12 +0100 |
|---|---|---|
| committer | J08nY | 2020-02-13 18:29:24 +0100 |
| commit | eef8b99dad6f43d97d9194a1a6f16bc5e2ef66b0 (patch) | |
| tree | 8748dc624cc8047b9f1410b65ac0e6acf7df08eb /docs | |
| parent | ac0f153698adc4dfde4c8066d6052b916878f14a (diff) | |
| download | pyecsca-eef8b99dad6f43d97d9194a1a6f16bc5e2ef66b0.tar.gz pyecsca-eef8b99dad6f43d97d9194a1a6f16bc5e2ef66b0.tar.zst pyecsca-eef8b99dad6f43d97d9194a1a6f16bc5e2ef66b0.zip | |
Add notebooks, fix Travis.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 11 | ||||
| -rw-r--r-- | docs/index.rst | 15 |
2 files changed, 19 insertions, 7 deletions
diff --git a/docs/conf.py b/docs/conf.py index 2b1ee9c..f84364b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,15 +12,15 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import sys +sys.path.insert(0, os.path.abspath('../notebook/')) # -- Project information ----------------------------------------------------- project = 'pyecsca' -copyright = '2018-2019, Jan Jancar' +copyright = '2018-2020, Jan Jancar' author = 'Jan Jancar' import sys; import os; sys.path.append(os.path.abspath('..')) @@ -46,6 +46,7 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', + 'nbsphinx' ] # Add any paths that contain templates here, relative to this directory. @@ -70,7 +71,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "trac" 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/ |