aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2013-12-12 13:08:28 -0800
committerPaul Kehrer <paul.l.kehrer@gmail.com>2013-12-12 13:08:28 -0800
commit7d78a5b9f3dd4c31efc3f07769f45ace5aefee86 (patch)
treeea570fb833beddc31223b0db5ea06930b24de211
parent4474be6678f6b77fdcf2bc692d3bf3ccfdd54c5f (diff)
parent5246e2db3100160b948a632e810010e1b23a9e91 (diff)
downloadcryptography-7d78a5b9f3dd4c31efc3f07769f45ace5aefee86.tar.gz
cryptography-7d78a5b9f3dd4c31efc3f07769f45ace5aefee86.tar.bz2
cryptography-7d78a5b9f3dd4c31efc3f07769f45ace5aefee86.zip
Merge pull request #298 from alex/fix-headers
Fixed headers in docs
-rw-r--r--docs/contributing.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 4647818a..934bb45a 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -48,7 +48,7 @@ Additionally, every Python code file must contain
from __future__ import absolute_import, division, print_function
C bindings
-----------
+~~~~~~~~~~
When binding C code with ``cffi`` we have our own style guide, it's pretty
simple.
@@ -161,7 +161,7 @@ dependencies, install ``cryptography`` in ``editable`` mode. For example:
You are now ready to run the tests and build the documentation.
Running Tests
--------------
+~~~~~~~~~~~~~
``cryptography`` unit tests are found in the ``tests/`` directory and are
designed to be run using `pytest`_. `pytest`_ will discover the tests
@@ -195,7 +195,7 @@ You may not have all the required Python versions installed, in which case you
will see one or more ``InterpreterNotFound`` errors.
Building Documentation
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
``cryptography`` documentation is stored in the ``docs/`` directory. It is
written in `reStructured Text`_ and rendered using `Sphinx`_.