From 0f3b36d55cddb350c8d88a4fdda0d1ec1aa103fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mois=C3=A9s=20Guimar=C3=A3es?= Date: Sun, 1 May 2016 11:37:04 -0300 Subject: [PATCH] updates docs. --- docs/conf.py | 13 +++++---- docs/index.rst | 10 ++----- wolfcrypt/__about__.py | 60 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 70 insertions(+), 13 deletions(-) create mode 100644 wolfcrypt/__about__.py diff --git a/docs/conf.py b/docs/conf.py index a1ecf27..c950fff 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -53,17 +53,20 @@ master_doc = 'index' # General information about the project. project = u'wolfcrypt-py' -copyright = u'2016, wolfSSL' +copyright = u'2016, 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. # -# The short X.Y version. -version = u'0.1' -# The full version, including alpha/beta/rc tags. -release = u'0.1.0' + +base_dir = os.path.join(os.path.dirname(__file__), os.pardir) +about = {} +with open(os.path.join(base_dir, "wolfcrypt", "__about__.py")) as f: + exec(f.read(), about) + +version = release = about["__version__"] # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/index.rst b/docs/index.rst index a8a1580..2864828 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,5 @@ -.. wolfcrypt-py documentation master file, created by - sphinx-quickstart on Fri Apr 29 16:47:53 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to wolfcrypt-py's documentation! -======================================== +Welcome to ``wolfcrypt-py`` +=========================== Contents: @@ -19,4 +14,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/wolfcrypt/__about__.py b/wolfcrypt/__about__.py new file mode 100644 index 0000000..8c88b65 --- /dev/null +++ b/wolfcrypt/__about__.py @@ -0,0 +1,60 @@ +# __about__.py +# +# Copyright (C) 2006-2016 wolfSSL Inc. +# +# This file is part of wolfSSL. (formerly known as CyaSSL) +# +# wolfSSL is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# wolfSSL is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +from __future__ import absolute_import, division, print_function + +__all__ = [ + "__title__", "__summary__", "__uri__", "__version__", "__author__", + "__email__", "__license__", "__copyright__", +] + +__title__ = "wolfcrypt" +__summary__ = ("A Python wrapper that encapsulates wolfSSL's wolfCrypt API.") +__uri__ = "https://github.com/wolfssl/wolfcrypt-py" + +__version__ = "0.1.0" + +__author__ = "wolfSSL Inc." +__email__ = "info@wolfssl.com" + +__license__ = """ + wolfSSL’s software is available under two distinct licensing models: + open source and standard commercial licensing. Please see the relevant + section below for information on each type of license. + + Open Source + + wolfSSL (formerly CyaSSL), yaSSL, wolfCrypt, yaSSH and TaoCrypt software + are free software downloads and may be modified to the needs of the user + as long as the user adheres to version two of the GPL License. The GPLv2 + license can be found on the gnu.org website: + http://www.gnu.org/licenses/old-licenses/gpl-2.0.html + + Commercial Licensing + + Businesses and enterprises who wish to incorporate wolfSSL products into + proprietary appliances or other commercial software products for + re-distribution must license commercial versions. Commercial licenses for + wolfSSL, yaSSL, and wolfCrypt are available for $5,000 USD per end product + or SKU. Licenses are generally issued for one product and include unlimited + royalty-free distribution. Custom licensing terms are also available. +""" + +__copyright__ = "Copyright 2016 {0}".format(__author__)