aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cryptography-docs.py
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2014-01-07 12:26:33 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2014-01-07 12:26:33 -0800
commitd7e04ae2f45c99034d564fd6a7747bf216d00ea9 (patch)
tree3aa52344b3c0a9c4f7457a281acba849a31655dc /docs/cryptography-docs.py
parentffa8b4d5fedad8f9c1fdbd05a2da8fb2679168af (diff)
parent168c29d6d74060b0d9f592b740f8913cc5d07c5e (diff)
downloadcryptography-d7e04ae2f45c99034d564fd6a7747bf216d00ea9.tar.gz
cryptography-d7e04ae2f45c99034d564fd6a7747bf216d00ea9.tar.bz2
cryptography-d7e04ae2f45c99034d564fd6a7747bf216d00ea9.zip
Merge branch 'master' into setup-install-extension
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,