aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cryptography-docs.py
diff options
context:
space:
mode:
authorDavid Reid <dreid@dreid.org>2014-01-06 13:06:11 -0800
committerDavid Reid <dreid@dreid.org>2014-01-06 13:06:11 -0800
commitbf41d5ca7e7a38881c35bc742072b693147e8fa4 (patch)
tree5e5e4e20395a074c0aa2d03fcda45a6e3f1631db /docs/cryptography-docs.py
parent3450b0e1376d8738e4cf05a8541827f0949b6d6a (diff)
parent5bae063ff2601db15d84920f18bae194bcd3d373 (diff)
downloadcryptography-bf41d5ca7e7a38881c35bc742072b693147e8fa4.tar.gz
cryptography-bf41d5ca7e7a38881c35bc742072b693147e8fa4.tar.bz2
cryptography-bf41d5ca7e7a38881c35bc742072b693147e8fa4.zip
Merge pull request #203 from alex/fernet
[WIP][POC] Implement Fernet
Diffstat (limited to 'docs/cryptography-docs.py')
-rw-r--r--docs/cryptography-docs.py16
1 files changed, 14 insertions, 2 deletions
diff --git a/docs/cryptography-docs.py b/docs/cryptography-docs.py
index ea7e8eef..0252d693 100644
--- a/docs/cryptography-docs.py
+++ b/docs/cryptography-docs.py
@@ -6,17 +6,29 @@ from sphinx.util.compat import Directive, make_admonition
DANGER_MESSAGE = """
This is a "Hazardous Materials" module. You should **ONLY** use it if you're
100% absolutely sure that you know what you're doing because this module is
-full of land mines, dragons, and dinosaurs with laser guns. """
+full of land mines, dragons, and dinosaurs with laser guns.
+"""
+
+DANGER_ALTERNATE = """
+
+You may instead be interested in :doc:`{alternate}`.
+"""
class HazmatDirective(Directive):
+ has_content = True
+
def run(self):
+ message = DANGER_MESSAGE
+ if self.content:
+ message += DANGER_ALTERNATE.format(alternate=self.content[0])
+
ad = make_admonition(
Hazmat,
self.name,
[],
self.options,
- nodes.paragraph("", DANGER_MESSAGE),
+ nodes.paragraph("", message),
self.lineno,
self.content_offset,
self.block_text,