aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Heimes <christian@cheimes.de>2013-08-11 15:11:04 +0200
committerChristian Heimes <christian@cheimes.de>2013-08-11 15:11:04 +0200
commit0797276a4e334b4adb12ccd90f4fcb19dba2ec42 (patch)
tree48f0889943d79bf2c244306c8bf683546d6b20de
parentb55f9269ec5d9674bc76fe652f54a62322ee9577 (diff)
parent32d136ef394dcb25a816b0aa76ce2cc113638734 (diff)
downloadcryptography-0797276a4e334b4adb12ccd90f4fcb19dba2ec42.tar.gz
cryptography-0797276a4e334b4adb12ccd90f4fcb19dba2ec42.tar.bz2
cryptography-0797276a4e334b4adb12ccd90f4fcb19dba2ec42.zip
Merge remote-tracking branch 'upstream/master'
-rw-r--r--CONTRIBUTING.rst17
-rw-r--r--README.rst6
2 files changed, 18 insertions, 5 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index ff1a619c..3ee89b80 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -10,6 +10,13 @@ Code
When in doubt, refer to `PEP 8`_ for Python code.
+Every code file must start with the boilerplate notice of the Apache License.
+Additionally, every Python code file must contain
+
+.. code-block:: python
+
+ from __future__ import absolute_import, division, print_function
+
Docs
====
@@ -17,12 +24,12 @@ Write docstrings like this:
.. code-block:: python
- def some_function(some_arg):
- """
- Does some things.
+ def some_function(some_arg):
+ """
+ Does some things.
- :param some_arg: Some argument.
- """
+ :param some_arg: Some argument.
+ """
So, specifically:
diff --git a/README.rst b/README.rst
index 4379bb58..77fcc6ca 100644
--- a/README.rst
+++ b/README.rst
@@ -13,9 +13,15 @@ recipes to Python developers.
It is currently in early development and isn't recommended for general usage
yet. It targets Python 2.6-2.7, Python 3.2+, as well as PyPy.
+You can find more documentation at `Read The Docs`_.
+
+.. _`Read The Docs`: https://cryptography.readthedocs.org/
+
+
Why a new crypto library for Python?
------------------------------------
None of the existing ones work on PyPy, and many of them are unmaintained or
are based around very poor implementations of algorithms (i.e ones with known
side-channel attacks).
+