diff options
| -rw-r--r-- | docs/conf.py | 12 | ||||
| -rw-r--r-- | docs/installation.rst | 2 | ||||
| -rw-r--r-- | pyecsca/ec/mult/ladder.py | 2 | ||||
| -rw-r--r-- | pyproject.toml | 2 |
4 files changed, 15 insertions, 3 deletions
diff --git a/docs/conf.py b/docs/conf.py index d47f4fc..0f9ac1d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,8 @@ extensions = [ 'sphinx.ext.linkcode', 'sphinx_paramlinks', 'sphinx_design', - 'nbsphinx' + 'nbsphinx', + 'sphinx_plausible', ] # Add any paths that contain templates here, relative to this directory. @@ -253,3 +254,12 @@ def linkcode_resolve(domain, info): return "https://github.com/J08nY/pyecsca-codegen/tree/master/%s.py" % filename else: return "https://github.com/J08nY/pyecsca/tree/master/%s.py" % filename + + +plausible_domain = "pyecsca.org" +plausible_script = "https://plausible.neuromancer.sk/js/script.js" +plausible_enabled = ( + 'GITHUB_ACTION' in os.environ + and os.environ.get('GITHUB_REPOSITORY', '').lower() == 'J08nY/pyecsca' + and os.environ.get('GITHUB_REF') == 'refs/heads/main' + ) diff --git a/docs/installation.rst b/docs/installation.rst index 2917e01..1777a98 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -121,6 +121,7 @@ Requirements - nbsphinx_ - sphinx-paramlinks_ - sphinx-design_ + - sphinx-plausible_ Codegen ======= @@ -191,6 +192,7 @@ inside the notebook repository. .. _nbsphinx: https://nbsphinx.readthedocs.io/ .. _sphinx-paramlinks: https://pypi.org/project/sphinx-paramlinks/ .. _sphinx-design: https://pypi.org/project/sphinx_design/ +.. _sphinx-plausible: https://pypi.org/project/sphinx-plausible/ .. _Explicit-Formulas Database: https://www.hyperelliptic.org/EFD/index.html .. _crocs-muni/efd: https://github.com/crocs-muni/efd .. _ChipWhisperer: https://chipwhisperer.com diff --git a/pyecsca/ec/mult/ladder.py b/pyecsca/ec/mult/ladder.py index 3c141cd..5f5d8a2 100644 --- a/pyecsca/ec/mult/ladder.py +++ b/pyecsca/ec/mult/ladder.py @@ -20,7 +20,7 @@ class LadderMultiplier(ScalarMultiplier): """ Montgomery ladder multiplier, using a three input, two output ladder formula. - Optionally takes a doubling formula, and if `complete` is false, it requires one. + Optionally takes a doubling formula, and if both `complete` and `full` is false, it requires one. :param short_circuit: Whether the use of formulas will be guarded by short-circuit on inputs of the point at infinity. diff --git a/pyproject.toml b/pyproject.toml index 3a0700e..82242c0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -73,7 +73,7 @@ "pari" = ["cysignals", "cypari2"] "dev" = ["mypy", "flake8", "interrogate", "pyinstrument", "black", "types-setuptools", "pydocstyle"] "test" = ["pytest>=7.0.0", "coverage", "pytest-cov", "pytest-sugar", "pytest-mock", "nbmake"] - "doc" = ["sphinx", "sphinx-autodoc-typehints", "nbsphinx", "sphinx-paramlinks", "sphinx_design", "alabaster>=0.7.16"] + "doc" = ["sphinx", "sphinx-autodoc-typehints", "nbsphinx", "sphinx-paramlinks", "sphinx_design", "sphinx-plausible", "alabaster>=0.7.16"] [tool.setuptools.packages.find] include = ["pyecsca*"] |