updates copyright and fixes docs
parent
0a6147fc9d
commit
b4556ba294
1
Makefile
1
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
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
13
docs/conf.py
13
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.
|
||||
|
|
|
@ -26,6 +26,7 @@ Classes
|
|||
|
||||
.. autoclass:: Aes
|
||||
|
||||
.. autoclass:: Des3
|
||||
|
||||
Example
|
||||
-------
|
||||
|
|
|
@ -0,0 +1,3 @@
|
|||
-r prod.txt
|
||||
Sphinx
|
||||
sphinx_rtd_theme
|
|
@ -1 +1 @@
|
|||
-r prod.txt
|
||||
-r prod.txt
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
-r prod.txt
|
||||
tox
|
||||
pytest
|
||||
pytest
|
||||
|
|
2
setup.py
2
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)
|
||||
#
|
||||
|
|
|
@ -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__",
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
|
@ -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)
|
||||
#
|
||||
|
|
Loading…
Reference in New Issue