diff options
author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-10-29 17:11:25 -0700 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-10-29 17:11:25 -0700 |
commit | 05a190ee80dd57461c493f3a4a79a072612d3622 (patch) | |
tree | 7a4bccd6627bdff45483b2325a4cd387b03814db | |
parent | af82d5eaeda02561b29adec38d40bf22c3a8e23b (diff) | |
download | cryptography-05a190ee80dd57461c493f3a4a79a072612d3622.tar.gz cryptography-05a190ee80dd57461c493f3a4a79a072612d3622.tar.bz2 cryptography-05a190ee80dd57461c493f3a4a79a072612d3622.zip |
Document that you should use the hazmat directive
-rw-r--r-- | docs/contributing.rst | 15 |
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 ----------------------- |