sphinx.domains.std.Cmdoption

class documentation

class Cmdoption(ObjectDescription[str]):

View In Hierarchy

Description of a command-line option (.. option).
Method add​_target​_and​_index Undocumented
Method handle​_signature Transform an option description into RST nodes.
Method make​_old​_id Generate old styled node_id for cmdoption.
def add_target_and_index(self, firstname, sig, signode):

Undocumented

Parameters
firstname:strUndocumented
sig:strUndocumented
signode:desc_signatureUndocumented
def handle_signature(self, sig, signode):
Transform an option description into RST nodes.
Parameters
sig:strUndocumented
signode:desc_signatureUndocumented
Returns
strUndocumented
def make_old_id(self, prefix, optname):

Generate old styled node_id for cmdoption.

Note

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

Parameters
prefix:strUndocumented
optname:strUndocumented
Returns
strUndocumented