Code

class sphinx_rfc2119.MandatoryListDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
has_content = True
run()[source]
class sphinx_rfc2119.MayDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'May'
requirement_class = 'optional'
class sphinx_rfc2119.MustDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Must'
requirement_class = 'mandatory'
class sphinx_rfc2119.MustNotDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Must Not'
requirement_class = 'mandatory'
class sphinx_rfc2119.NotRecommendedDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Not Recommended'
requirement_class = 'recommendation'
class sphinx_rfc2119.OptionalDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Optional'
requirement_class = 'optional'
class sphinx_rfc2119.OptionalListDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
has_content = True
run()[source]
class sphinx_rfc2119.RecommendationListDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
has_content = True
run()[source]
class sphinx_rfc2119.RecommendedDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Recommended'
requirement_class = 'recommendation'
class sphinx_rfc2119.RequiredDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Required'
requirement_class = 'mandatory'
class sphinx_rfc2119.ShallDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Shall'
requirement_class = 'mandatory'
class sphinx_rfc2119.ShallNotDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Shall Not'
requirement_class = 'mandatory'
class sphinx_rfc2119.ShouldDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Should'
requirement_class = 'recommendation'
class sphinx_rfc2119.ShouldNotDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
label = 'Should Not'
requirement_class = 'recommendation'
sphinx_rfc2119.depart_rfc2119_node(self, node)[source]
class sphinx_rfc2119.mandatory(rawsource='', *children, **attributes)[source]
class sphinx_rfc2119.mandatorylist(rawsource='', *children, **attributes)[source]
class sphinx_rfc2119.optional(rawsource='', *children, **attributes)[source]
class sphinx_rfc2119.optionallist(rawsource='', *children, **attributes)[source]
sphinx_rfc2119.process_rfc2119_nodes(app, doctree, fromdocname)[source]
sphinx_rfc2119.purge_rfc2119_mandatory(app, env, docname)[source]
sphinx_rfc2119.purge_rfc2119_optional(app, env, docname)[source]
sphinx_rfc2119.purge_rfc2119_recommendation(app, env, docname)[source]
class sphinx_rfc2119.recommendationlist(rawsource='', *children, **attributes)[source]
class sphinx_rfc2119.recommended(rawsource='', *children, **attributes)[source]
class sphinx_rfc2119.rfc2119Directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

An abstract base for rfc2199 requirements.

has_content = True
label = 'rfc2119'
requirement_class = 'rfc2119'
run()[source]
class sphinx_rfc2119.rfc2119InterpretationDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]
has_content = False
run()[source]
class sphinx_rfc2119.rfc2119interpretation(rawsource='', *children, **attributes)[source]
sphinx_rfc2119.setup(app)[source]
sphinx_rfc2119.visit_rfc2119_node(self, node)[source]