diff --git a/Makefile b/Makefile index 56320e7..1967c00 100644 --- a/Makefile +++ b/Makefile @@ -69,7 +69,6 @@ coverage: ## check code coverage quickly with the default Python docs: ## generate Sphinx HTML documentation, including API docs rm -f docs/wolfcrypt.rst rm -f docs/modules.rst - sphinx-apidoc -o docs/ wolfcrypt $(MAKE) -C docs clean $(MAKE) -C docs html $(BROWSER) docs/_build/html/index.html diff --git a/docs/Makefile b/docs/Makefile index 8d76b70..bcf399d 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,6 +1,6 @@ # Makefile for Sphinx documentation # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/docs/conf.py b/docs/conf.py index c78b2cb..ab61bf8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,8 +12,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys -import os +import wolfcrypt import sphinx_rtd_theme # If extensions (or modules to document with autodoc) are in another directory, @@ -53,20 +52,14 @@ master_doc = 'index' # General information about the project. project = u'wolfcrypt Python' -copyright = u'2017, wolfSSL Inc. All rights reserved' +copyright = u'2018, wolfSSL Inc. All rights reserved' author = u'wolfSSL' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # - -base_dir = os.path.join(os.path.dirname(__file__), os.pardir, "src") -about = {} -with open(os.path.join(base_dir, "wolfcrypt", "__about__.py")) as f: - exec(f.read(), about) - -version = release = about["__version__"] +version = release = wolfcrypt.__version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/symmetric.rst b/docs/symmetric.rst index a493983..4f1abaa 100644 --- a/docs/symmetric.rst +++ b/docs/symmetric.rst @@ -26,6 +26,7 @@ Classes .. autoclass:: Aes +.. autoclass:: Des3 Example ------- diff --git a/requirements/docs.txt b/requirements/docs.txt new file mode 100644 index 0000000..651f417 --- /dev/null +++ b/requirements/docs.txt @@ -0,0 +1,3 @@ +-r prod.txt +Sphinx +sphinx_rtd_theme diff --git a/requirements/setup.txt b/requirements/setup.txt index 35a5061..ca0c6f8 100644 --- a/requirements/setup.txt +++ b/requirements/setup.txt @@ -1 +1 @@ --r prod.txt \ No newline at end of file +-r prod.txt diff --git a/requirements/test.txt b/requirements/test.txt index 51e9a26..8c01ca8 100644 --- a/requirements/test.txt +++ b/requirements/test.txt @@ -1,3 +1,3 @@ -r prod.txt tox -pytest \ No newline at end of file +pytest diff --git a/setup.py b/setup.py index c8f62b1..bd028ab 100755 --- a/setup.py +++ b/setup.py @@ -1,7 +1,7 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/src/wolfcrypt/__init__.py b/src/wolfcrypt/__init__.py index 0ffdf71..9e39da1 100644 --- a/src/wolfcrypt/__init__.py +++ b/src/wolfcrypt/__init__.py @@ -1,6 +1,6 @@ # __init__.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # @@ -38,7 +38,7 @@ __author__ = "wolfSSL Inc." __email__ = "info@wolfssl.com" __license__ = "GPLv2 or Commercial License" -__copyright__ = "Copyright (C) 2006-2017 wolfSSL Inc" +__copyright__ = "Copyright (C) 2006-2018 wolfSSL Inc" __all__ = [ "__title__", "__summary__", "__uri__", "__version__", diff --git a/src/wolfcrypt/_build_ffi.py b/src/wolfcrypt/_build_ffi.py index ee3d443..a077dd0 100644 --- a/src/wolfcrypt/_build_ffi.py +++ b/src/wolfcrypt/_build_ffi.py @@ -1,6 +1,6 @@ # build_ffi.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/src/wolfcrypt/_build_wolfssl.py b/src/wolfcrypt/_build_wolfssl.py index a3428e8..fb261de 100644 --- a/src/wolfcrypt/_build_wolfssl.py +++ b/src/wolfcrypt/_build_wolfssl.py @@ -1,7 +1,7 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/src/wolfcrypt/ciphers.py b/src/wolfcrypt/ciphers.py index 8beaea6..7de827a 100644 --- a/src/wolfcrypt/ciphers.py +++ b/src/wolfcrypt/ciphers.py @@ -1,6 +1,6 @@ # ciphers.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/src/wolfcrypt/exceptions.py b/src/wolfcrypt/exceptions.py index 29ef5e5..20b0153 100644 --- a/src/wolfcrypt/exceptions.py +++ b/src/wolfcrypt/exceptions.py @@ -1,6 +1,6 @@ # exceptions.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/src/wolfcrypt/hashes.py b/src/wolfcrypt/hashes.py index 1049634..7d38ed4 100644 --- a/src/wolfcrypt/hashes.py +++ b/src/wolfcrypt/hashes.py @@ -1,6 +1,6 @@ # hashes.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/src/wolfcrypt/random.py b/src/wolfcrypt/random.py index 0f07a3e..d38737b 100644 --- a/src/wolfcrypt/random.py +++ b/src/wolfcrypt/random.py @@ -1,6 +1,6 @@ # random.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/src/wolfcrypt/utils.py b/src/wolfcrypt/utils.py index fb3ed9c..9a84c84 100644 --- a/src/wolfcrypt/utils.py +++ b/src/wolfcrypt/utils.py @@ -1,6 +1,6 @@ # utils.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/tests/test_ciphers.py b/tests/test_ciphers.py index 97dd193..60a2491 100644 --- a/tests/test_ciphers.py +++ b/tests/test_ciphers.py @@ -1,6 +1,6 @@ # test_ciphers.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/tests/test_hashes.py b/tests/test_hashes.py index c472373..4a1d627 100644 --- a/tests/test_hashes.py +++ b/tests/test_hashes.py @@ -1,6 +1,6 @@ # test_hashes.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) # diff --git a/tests/test_random.py b/tests/test_random.py index 0ae5c1c..7789b50 100644 --- a/tests/test_random.py +++ b/tests/test_random.py @@ -1,6 +1,6 @@ # test_random.py # -# Copyright (C) 2006-2017 wolfSSL Inc. +# Copyright (C) 2006-2018 wolfSSL Inc. # # This file is part of wolfSSL. (formerly known as CyaSSL) #