aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.rst
diff options
context:
space:
mode:
authorDonald Stufft <donald@stufft.io>2013-10-29 19:02:51 -0700
committerDonald Stufft <donald@stufft.io>2013-10-29 19:02:51 -0700
commit6f6d6087cf5747629d51bca3333e6c2be91ca28b (patch)
tree6bc1c563bd230dd74d6052d5f8ee6ddf8213a169 /docs/contributing.rst
parentacfdd61e8e67b8d2df2d4662631e8f8e1c1bc0c0 (diff)
parentb8be0e9a6363d94d32eecaeb6eacfb9168839338 (diff)
downloadcryptography-6f6d6087cf5747629d51bca3333e6c2be91ca28b.tar.gz
cryptography-6f6d6087cf5747629d51bca3333e6c2be91ca28b.tar.bz2
cryptography-6f6d6087cf5747629d51bca3333e6c2be91ca28b.zip
Merge pull request #195 from alex/sphinx-hazmat-plugin
Sphinx hazmat plugin
Diffstat (limited to 'docs/contributing.rst')
-rw-r--r--docs/contributing.rst15
1 files changed, 11 insertions, 4 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 6a76c705..e1475b88 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -117,10 +117,17 @@ Docstrings should be written like this:
So, specifically:
-- Always use three double quotes.
-- Put the three double quotes on their own line.
-- No blank line at the end.
-- Use Sphinx parameter/attribute documentation `syntax`_.
+* Always use three double quotes.
+* Put the three double quotes on their own line.
+* No blank line at the end.
+* Use Sphinx parameter/attribute documentation `syntax`_.
+
+When documenting a new module in the ``hazmat`` package, its documentation
+should begin with the "Hazardous Materials" warning:
+
+.. code-block:: rest
+
+ .. hazmat::
Development Environment
-----------------------