diff options
| author | J08nY | 2021-04-11 14:16:57 +0200 |
|---|---|---|
| committer | J08nY | 2021-04-11 14:16:57 +0200 |
| commit | 942c0fb9d6fcbff7c91c553211cc81c7e0939e4e (patch) | |
| tree | 1df80da6030019ef2a7490d2b2050a7d4b9a83ec /docs | |
| parent | a2e01e037fcde3e63571633e94156e324a4f2299 (diff) | |
| download | pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.tar.gz pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.tar.zst pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.zip | |
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/index.rst | 9 |
2 files changed, 8 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 8fafb3b..f8499fe 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -46,6 +46,7 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', + 'sphinx_paramlinks', 'nbsphinx' ] diff --git a/docs/index.rst b/docs/index.rst index bde29be..bb95c4a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -98,8 +98,11 @@ Requirements It also supports working with Riscure_ Inspector trace sets, which are of a proprietary format. -Testing -------- +Testing & Development +--------------------- + +See the Makefile for tests, performance measurement, codestyle and type checking commands. +Use black_ for code-formatting. - nose2_ - green_ @@ -118,6 +121,7 @@ Docs - sphinx_ - sphinx-autodoc-typehints_ - nbsphinx_ + - sphinx-paramlinks_ License ======= @@ -178,5 +182,6 @@ this support is very appreciated. .. _sphinx: https://www.sphinx-doc.org/ .. _sphinx-autodoc-typehints: https://pypi.org/project/sphinx-autodoc-typehints/ .. _nbsphinx: https://nbsphinx.readthedocs.io/ +.. _sphinx-paramlinks: https://pypi.org/project/sphinx-paramlinks/ .. _Explicit-Formulas Database: https://www.hyperelliptic.org/EFD/index.html .. _Riscure: https://www.riscure.com/ |