ipypublish.sphinx.gls.roles module

class ipypublish.sphinx.gls.roles.GLSCapitalRole(fix_parens: bool = False, lowercase: bool = False, nodeclass: Type[Element] = None, innernodeclass: Type[TextElement] = None, warn_dangling: bool = False)

Bases: sphinx.roles.XRefRole

Class for processing the glsc role.

result_nodes(document, env, node, is_ref)

Transform reference node into a citation reference, and note that the reference was cited.

class ipypublish.sphinx.gls.roles.GLSPluralCapitalRole(fix_parens: bool = False, lowercase: bool = False, nodeclass: Type[Element] = None, innernodeclass: Type[TextElement] = None, warn_dangling: bool = False)

Bases: sphinx.roles.XRefRole

Class for processing the glscpl role.

result_nodes(document, env, node, is_ref)

Transform reference node into a citation reference, and note that the reference was cited.

class ipypublish.sphinx.gls.roles.GLSPluralRole(fix_parens: bool = False, lowercase: bool = False, nodeclass: Type[Element] = None, innernodeclass: Type[TextElement] = None, warn_dangling: bool = False)

Bases: sphinx.roles.XRefRole

Class for processing the glspl role.

result_nodes(document, env, node, is_ref)

Transform reference node into a citation reference, and note that the reference was cited.

class ipypublish.sphinx.gls.roles.GLSRole(fix_parens: bool = False, lowercase: bool = False, nodeclass: Type[Element] = None, innernodeclass: Type[TextElement] = None, warn_dangling: bool = False)

Bases: sphinx.roles.XRefRole

Class for processing the gls role.

result_nodes(document, env, node, is_ref)

Transform reference node into a citation reference, and note that the reference was cited.