aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cryptography-docs.py
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-12-20 13:51:42 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2013-12-20 13:51:42 -0800
commit2724ff6af8ba5f8dfd1f0f511ed95fab5cd8abd8 (patch)
tree90f95e72e5650baf51beddc8484bc5bc60334ce8 /docs/cryptography-docs.py
parent719eb6a412b5d3eab3ca84a9d4e8af76955bcbcc (diff)
downloadcryptography-2724ff6af8ba5f8dfd1f0f511ed95fab5cd8abd8.tar.gz
cryptography-2724ff6af8ba5f8dfd1f0f511ed95fab5cd8abd8.tar.bz2
cryptography-2724ff6af8ba5f8dfd1f0f511ed95fab5cd8abd8.zip
Link from symmetric encryption to fernet
Diffstat (limited to 'docs/cryptography-docs.py')
-rw-r--r--docs/cryptography-docs.py17
1 files changed, 15 insertions, 2 deletions
diff --git a/docs/cryptography-docs.py b/docs/cryptography-docs.py
index ea7e8eef..f07c18bb 100644
--- a/docs/cryptography-docs.py
+++ b/docs/cryptography-docs.py
@@ -6,17 +6,30 @@ 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,