71 lines
1.7 KiB
Python
71 lines
1.7 KiB
Python
# This file is dual licensed under the terms of the Apache License, Version
|
|
# 2.0, and the BSD License. See the LICENSE file in the root of this repository
|
|
# for complete details.
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
from docutils import nodes
|
|
|
|
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.
|
|
"""
|
|
|
|
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("", message),
|
|
self.lineno,
|
|
self.content_offset,
|
|
self.block_text,
|
|
self.state,
|
|
self.state_machine
|
|
)
|
|
ad[0].line = self.lineno
|
|
return ad
|
|
|
|
|
|
class Hazmat(nodes.Admonition, nodes.Element):
|
|
pass
|
|
|
|
|
|
def html_visit_hazmat_node(self, node):
|
|
return self.visit_admonition(node, "danger")
|
|
|
|
|
|
def latex_visit_hazmat_node(self, node):
|
|
return self.visit_admonition(node)
|
|
|
|
|
|
def depart_hazmat_node(self, node):
|
|
return self.depart_admonition(node)
|
|
|
|
|
|
def setup(app):
|
|
app.add_node(
|
|
Hazmat,
|
|
html=(html_visit_hazmat_node, depart_hazmat_node),
|
|
latex=(latex_visit_hazmat_node, depart_hazmat_node),
|
|
)
|
|
app.add_directive("hazmat", HazmatDirective)
|