diff options
| author | J08nY | 2019-12-21 16:41:20 +0100 |
|---|---|---|
| committer | J08nY | 2019-12-21 16:41:20 +0100 |
| commit | 5044b150a38c4701de816dbe62f16532ce6d5d66 (patch) | |
| tree | e1f0ff72c58677921f0691af5611b88d700d498f /docs | |
| parent | f55dcac64125508d0454d17fe54ab87bb7816930 (diff) | |
| download | pyecsca-5044b150a38c4701de816dbe62f16532ce6d5d66.tar.gz pyecsca-5044b150a38c4701de816dbe62f16532ce6d5d66.tar.zst pyecsca-5044b150a38c4701de816dbe62f16532ce6d5d66.zip | |
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 8 | ||||
| -rw-r--r-- | docs/_static/.gitignore | 2 | ||||
| -rw-r--r-- | docs/conf.py | 7 | ||||
| -rw-r--r-- | docs/index.rst | 20 |
4 files changed, 25 insertions, 12 deletions
diff --git a/docs/Makefile b/docs/Makefile index 704c458..c12361e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -13,8 +13,12 @@ help: @echo " apidoc to build api docs" apidoc: - mkdir -p api/ - sphinx-apidoc ../pyecsca/ -f -e -o api/ + mkdir -p api/codegen/ + sphinx-apidoc ../pyecsca/ --ext-autodoc -f -e -o api/ + sed -i "s/automodule:: /automodule:: pyecsca./g" api/*.rst + sphinx-apidoc ../../pyecsca-codegen/pyecsca/ --ext-autodoc -f -e -o api/codegen/ + sed -i "s/automodule:: /automodule:: pyecsca./g" api/codegen/*.rst + echo " codegen/codegen" >> api/modules.rst .PHONY: help apidoc Makefile diff --git a/docs/_static/.gitignore b/docs/_static/.gitignore new file mode 100644 index 0000000..d5ecedf --- /dev/null +++ b/docs/_static/.gitignore @@ -0,0 +1,2 @@ +font/ +graphik.css
\ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 42b9090..f219c17 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- project = 'pyecsca' -copyright = '2018, Jan Jancar' +copyright = '2018-2019, Jan Jancar' author = 'Jan Jancar' import sys; import os; sys.path.append(os.path.abspath('..')) @@ -104,6 +104,11 @@ html_static_path = ['_static'] html_favicon = "_static/logo_black.png" +html_css_files = [ + 'custom.css', + 'graphik.css' +] + # Custom sidebar templates, must be a dictionary that maps document names # to template names. # diff --git a/docs/index.rst b/docs/index.rst index 13d70ac..795713b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,17 @@ -.. 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 **E**\ lliptic **C**\ urve cryptography **S**\ ide-**C**\ hannel **A**\ nalysis toolkit. +.. 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 +.. 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 + :target: https://codecov.io/gh/J08nY/pyecsca -Functionality -============= +**Py**\ thon **E**\ lliptic **C**\ urve cryptography **S**\ ide-**C**\ hannel **A**\ nalysis toolkit. *pyecsca* aims to fill a gap in SCA tooling for Elliptic Curve Cryptography, it focuses on black-box implementations of ECC and presents a way to extract implementation information @@ -24,8 +25,9 @@ API .. toctree:: :titlesonly: + :maxdepth: 3 - api/pyecsca + api/modules Requirements |
