diff options
author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-06 16:53:12 -0800 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-06 16:53:12 -0800 |
commit | 2f030efa617950e0d93ce869bae8119304dc8ba4 (patch) | |
tree | 91a446c0245d29cfb51ead0690cc4f66af6a7fee /docs/cryptography-docs.py | |
parent | 89063f687893417e1e5dac2e854a02d92037b6a0 (diff) | |
parent | 7507a1a7692ec7e26817d93dbcea3911eae3864b (diff) | |
download | cryptography-2f030efa617950e0d93ce869bae8119304dc8ba4.tar.gz cryptography-2f030efa617950e0d93ce869bae8119304dc8ba4.tar.bz2 cryptography-2f030efa617950e0d93ce869bae8119304dc8ba4.zip |
Merge branch 'master' into release-automation
Diffstat (limited to 'docs/cryptography-docs.py')
-rw-r--r-- | docs/cryptography-docs.py | 16 |
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, |