Skip to content

Commit a4c2202

Browse files
tomato42tomato42
authored
Merge pull request #255 from tomato42/doc-generation
Doc generation
2 parents f18c6d8 + ef898fc commit a4c2202

22 files changed

+355
-88
lines changed

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/conf.py

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
import os
14+
import sys
15+
16+
sys.path.insert(0, os.path.abspath("../../src"))
17+
18+
19+
# -- Project information -----------------------------------------------------
20+
21+
project = "python-ecdsa"
22+
copyright = "2021, Brian Warner and Hubert Kario"
23+
author = "Brian Warner and Hubert Kario"
24+
25+
# The full version, including alpha/beta/rc tags
26+
release = "0.17.0"
27+
28+
29+
# -- General configuration ---------------------------------------------------
30+
31+
# Add any Sphinx extension module names here, as strings. They can be
32+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33+
# ones.
34+
extensions = [
35+
"sphinx.ext.autodoc",
36+
"sphinx.ext.intersphinx",
37+
"sphinx.ext.coverage",
38+
"sphinx.ext.imgmath",
39+
"sphinx.ext.viewcode",
40+
]
41+
42+
# Add any paths that contain templates here, relative to this directory.
43+
templates_path = ["_templates"]
44+
45+
# List of patterns, relative to source directory, that match files and
46+
# directories to ignore when looking for source files.
47+
# This pattern also affects html_static_path and html_extra_path.
48+
exclude_patterns = []
49+
50+
todo_include_todos = False
51+
52+
# -- Options for HTML output -------------------------------------------------
53+
54+
# The theme to use for HTML and HTML Help pages. See the documentation for
55+
# a list of builtin themes.
56+
#
57+
html_theme = "sphinx_rtd_theme"
58+
59+
# Add any paths that contain custom static files (such as style sheets) here,
60+
# relative to this directory. They are copied after the builtin static files,
61+
# so a file named "default.css" will overwrite the builtin "default.css".
62+
html_static_path = ["_static"]
63+
64+
autodoc_default_options = {
65+
"undoc-members": True,
66+
"inherited-members": True,
67+
}
68+
69+
intersphinx_mapping = {"https://docs.python.org/": None}

‎docs/source/ecdsa.curves.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.curves module
2+
===================
3+
4+
.. automodule:: ecdsa.curves
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ecdsa.der.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.der module
2+
================
3+
4+
.. automodule:: ecdsa.der
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ecdsa.ecdh.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.ecdh module
2+
=================
3+
4+
.. automodule:: ecdsa.ecdh
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ecdsa.ecdsa.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.ecdsa module
2+
==================
3+
4+
.. automodule:: ecdsa.ecdsa
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ecdsa.ellipticcurve.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.ellipticcurve module
2+
==========================
3+
4+
.. automodule:: ecdsa.ellipticcurve
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ecdsa.errors.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.errors module
2+
===================
3+
4+
.. automodule:: ecdsa.errors
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ecdsa.keys.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.keys module
2+
=================
3+
4+
.. automodule:: ecdsa.keys
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ecdsa.numbertheory.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.numbertheory module
2+
=========================
3+
4+
.. automodule:: ecdsa.numbertheory
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ecdsa.rfc6979.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.rfc6979 module
2+
====================
3+
4+
.. automodule:: ecdsa.rfc6979
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/ecdsa.rst

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
ecdsa package
2+
=============
3+
4+
.. automodule:: ecdsa
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
.. toctree::
13+
:maxdepth: 4
14+
15+
ecdsa.curves
16+
ecdsa.der
17+
ecdsa.ecdh
18+
ecdsa.ecdsa
19+
ecdsa.ellipticcurve
20+
ecdsa.errors
21+
ecdsa.keys
22+
ecdsa.numbertheory
23+
ecdsa.rfc6979
24+
ecdsa.util

‎docs/source/ecdsa.util.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ecdsa.util module
2+
=================
3+
4+
.. automodule:: ecdsa.util
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/index.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. python-ecdsa documentation master file, created by
2+
sphinx-quickstart on Sat May 29 18:34:49 2021.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to python-ecdsa's documentation!
7+
========================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`

‎docs/source/modules.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
src
2+
===
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
ecdsa

‎src/ecdsa/_compat.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ def a2b_hex(val):
128128
raise ValueError("base16 error: %s" % e)
129129

130130
# pylint: disable=invalid-name
131-
# pylint is stupid here and deson't notice it's a function, not
131+
# pylint is stupid here and doesn't notice it's a function, not
132132
# constant
133133
bytes_to_int = int.from_bytes
134134
# pylint: enable=invalid-name

‎src/ecdsa/ecdh.py

+10-10
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ def generate_private_key(self):
116116
:raises NoCurveError: Curve must be set before key generation.
117117
118118
:return: public (verifying) key from this private key.
119-
:rtype: VerifyingKey object
119+
:rtype: VerifyingKey
120120
"""
121121
if not self.curve:
122122
raise NoCurveError("Curve must be set prior to key generation.")
@@ -135,7 +135,7 @@ def load_private_key(self, private_key):
135135
:raises InvalidCurveError: private_key curve not the same as self.curve
136136
137137
:return: public (verifying) key from this private key.
138-
:rtype: VerifyingKey object
138+
:rtype: VerifyingKey
139139
"""
140140
if not self.curve:
141141
self.curve = private_key.curve
@@ -158,7 +158,7 @@ def load_private_key_bytes(self, private_key):
158158
:raises NoCurveError: Curve must be set before loading.
159159
160160
:return: public (verifying) key from this private key.
161-
:rtype: VerifyingKey object
161+
:rtype: VerifyingKey
162162
"""
163163
if not self.curve:
164164
raise NoCurveError("Curve must be set prior to key load.")
@@ -183,7 +183,7 @@ def load_private_key_der(self, private_key_der):
183183
:raises InvalidCurveError: private_key curve not the same as self.curve
184184
185185
:return: public (verifying) key from this private key.
186-
:rtype: VerifyingKey object
186+
:rtype: VerifyingKey
187187
"""
188188
return self.load_private_key(SigningKey.from_der(private_key_der))
189189

@@ -204,7 +204,7 @@ def load_private_key_pem(self, private_key_pem):
204204
:raises InvalidCurveError: private_key curve not the same as self.curve
205205
206206
:return: public (verifying) key from this private key.
207-
:rtype: VerifyingKey object
207+
:rtype: VerifyingKey
208208
"""
209209
return self.load_private_key(SigningKey.from_pem(private_key_pem))
210210

@@ -215,7 +215,7 @@ def get_public_key(self):
215215
Needs to be sent to the remote party.
216216
217217
:return: public (verifying) key from local private key.
218-
:rtype: VerifyingKey object
218+
:rtype: VerifyingKey
219219
"""
220220
return self.private_key.get_verifying_key()
221221

@@ -310,7 +310,7 @@ def generate_sharedsecret_bytes(self):
310310
:raises NoKeyError: public_key or private_key is not set
311311
312312
:return: shared secret
313-
:rtype: byte string
313+
:rtype: bytes
314314
"""
315315
return number_to_string(
316316
self.generate_sharedsecret(), self.private_key.curve.curve.p()
@@ -323,9 +323,9 @@ def generate_sharedsecret(self):
323323
The objects needs to have both private key and received public key
324324
before generation is allowed.
325325
326-
It's the same for local and remote party.
327-
shared secret(local private key, remote public key ) ==
328-
shared secret (local public key, remote private key)
326+
It's the same for local and remote party,
327+
shared secret(local private key, remote public key) ==
328+
shared secret(local public key, remote private key)
329329
330330
:raises InvalidCurveError: public_key curve not the same as self.curve
331331
:raises NoKeyError: public_key or private_key is not set

0 commit comments

Comments
 (0)