sphinx.domains.rst.ReSTDirectiveOption

class documentation

class ReSTDirectiveOption(ReSTMarkup):

View In Hierarchy

Description of an option for reST directive.
Method add​_target​_and​_index Undocumented
Method handle​_signature Undocumented
Method make​_old​_id Generate old styled node_id for directive options.
Class Variable option​_spec Undocumented
Property current​_directive Undocumented

Inherited from ReSTMarkup:

Method get​_index​_text Undocumented
def add_target_and_index(self, name, sig, signode):
overrides sphinx.domains.rst.ReSTMarkup.add_target_and_index

Undocumented

Parameters
name:strUndocumented
sig:strUndocumented
signode:desc_signatureUndocumented
def handle_signature(self, sig, signode):

Undocumented

Parameters
sig:strUndocumented
signode:desc_signatureUndocumented
Returns
strUndocumented
def make_old_id(self, name):
overrides sphinx.domains.rst.ReSTMarkup.make_old_id

Generate old styled node_id for directive options.

Note

Old Styled node_id was used until Sphinx-3.0. This will be removed in Sphinx-5.0.

Parameters
name:strUndocumented
Returns
strUndocumented
option_spec: OptionSpec =

Undocumented

@property
current_directive: str =

Undocumented