[Python-modules-commits] [pycryptodome] 01/05: Add documentation package

[Christopher Stuart Hoskin]

This is an automated email from the git hooks/post-receive script.

mans0954 pushed a commit to branch master
in repository pycryptodome.

commit 3ce0779ebdc332645b6fbb8a012d410b14ad6a6d
Author: Christopher Hoskin <mans0954 at debian.org>
Date:   Wed Jun 7 20:41:23 2017 +0100

    Add documentation package
---
 debian/control                          | 40 ++++++++++++++++++++++++++++++++-
 debian/python-pycryptodome-doc.doc-base |  9 ++++++++
 debian/python-pycryptodome-doc.docs     |  1 +
 debian/rules                            | 10 ++++++++-
 4 files changed, 58 insertions(+), 2 deletions(-)

diff --git a/debian/control b/debian/control
index a601267..d23dcdd 100644
--- a/debian/control
+++ b/debian/control
@@ -49,7 +49,7 @@ Description: cryptographic Python library (Python 2)
 Package: python3-pycryptodome
 Architecture: any
 Depends: ${misc:Depends}, ${python3:Depends}, ${shlibs:Depends}
-Description: cryptographic Python library for (Python 3)
+Description: cryptographic Python library (Python 3)
  PyCryptodome is a self-contained Python package of low-level
  cryptographic primitives.
  .
@@ -83,3 +83,41 @@ Description: cryptographic Python library for (Python 3)
  .
  This is the Python 3 version of the package.
 
+Package: python-pycryptodome-doc
+Architecture: all
+Section: doc
+Depends: ${sphinxdoc:Depends}, ${misc:Depends}
+Description: cryptographic Python library (documentation)
+ PyCryptodome is a self-contained Python package of low-level
+ cryptographic primitives.
+ .
+ PyCryptodome is a fork of PyCrypto. It brings several enhancements
+ with respect to the last official version of PyCrypto (2.6.1),
+ for instance:
+ .
+   * Authenticated encryption modes (GCM, CCM, EAX, SIV, OCB)
+   * Accelerated AES on Intel platforms via AES-NI
+   * First class support for PyPy
+   * Elliptic curves cryptography (NIST P-256 curve only)
+   * Better and more compact API (`nonce` and `iv` attributes for ciphers,
+     automatic generation of random nonces and IVs, simplified CTR cipher mode,
+     and more)
+   * SHA-3 (including SHAKE XOFs) and BLAKE2 hash algorithms
+   * Salsa20 and ChaCha20 stream ciphers
+   * scrypt and HKDF
+   * Deterministic (EC)DSA
+   * Password-protected PKCS#8 key containers
+   * Shamir's Secret Sharing scheme
+   * Random numbers get sourced directly from the OS (and not from a CSPRNG in
+     userspace)
+   * Simplified install process, including better support for Windows
+   * Cleaner RSA and DSA key generation (largely based on FIPS 186-4)
+   * Major clean ups and simplification of the code base
+ .
+ PyCryptodome is not a wrapper to a separate C library like *OpenSSL*.
+ To the largest possible extent, algorithms are implemented in pure Python.
+ Only the pieces that are extremely critical to performance (e.g. block ciphers)
+ are implemented as C extensions.
+ .
+ This is the documentation package.
+
diff --git a/debian/python-pycryptodome-doc.doc-base b/debian/python-pycryptodome-doc.doc-base
new file mode 100644
index 0000000..b5c6c1f
--- /dev/null
+++ b/debian/python-pycryptodome-doc.doc-base
@@ -0,0 +1,9 @@
+Document: pycryptodome
+Title: pycryptodome documentation
+Author: Legrandin <helderijs at gmail.com>
+Abstract: How to use the pycryptodome cryptographic Python library
+Section: Programming/Python
+ 
+Format: HTML
+Index: /usr/share/doc/python-pycryptodome-doc/html/index.html
+Files: /usr/share/doc/python-pycryptodome-doc/html/*.html         
diff --git a/debian/python-pycryptodome-doc.docs b/debian/python-pycryptodome-doc.docs
new file mode 100644
index 0000000..6d28621
--- /dev/null
+++ b/debian/python-pycryptodome-doc.docs
@@ -0,0 +1 @@
+build/html
diff --git a/debian/rules b/debian/rules
index 4469e78..2131596 100755
--- a/debian/rules
+++ b/debian/rules
@@ -10,8 +10,16 @@ export PYBUILD_NAME=pycryptodome
 export PYBUILD_BEFORE_BUILD=touch .separate_namespace
 export PYBUILD_AFTER_BUILD=rm .separate_namespace
 %:
-	dh $@ --with python2,python3 --buildsystem=pybuild
+	dh $@ --with python2,python3,sphinxdoc --buildsystem=pybuild
 
 override_dh_auto_test:
 	PYBUILD_SYSTEM=custom \
         PYBUILD_TEST_ARGS="python{version} -m Crypto.SelfTest {build_dir}/" dh_auto_test
+
+override_dh_auto_build: export http_proxy=127.0.0.1:9
+override_dh_auto_build: export https_proxy=127.0.0.1:9
+override_dh_auto_build:
+	dh_auto_build
+	PYTHONPATH=. sphinx-build -N -bhtml Doc/ build/html # HTML generator
+	PYTHONPATH=. sphinx-build -N -bman Doc/ build/man # Manpage generator
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/pycryptodome.git