ipypublish.sphinx.gls.transforms module

class ipypublish.sphinx.gls.transforms.BibGlossaryTransform(document, startnode=None)

Bases: docutils.transforms.Transform

A docutils transform to generate citation entries for bibglossary nodes.

apply()

Transform each BibGlossaryNode node into a list of glossary terms.

default_priority = 10

Priority of the transform. See http://docutils.sourceforge.net/docs/ref/transforms.html

class ipypublish.sphinx.gls.transforms.HandleMissingCitesTransform(document, startnode=None)

Bases: docutils.transforms.Transform

before sphinx.transforms.post_transforms.ReferencesResolver missing citations need to be handled (default_priority=10)

apply()

Override to apply the transform to the document tree.

default_priority = 9

class ipypublish.sphinx.gls.transforms.OverrideCitationReferences(document, startnode=None)

Bases: docutils.transforms.Transform

Replace citation references by pending_xref nodes before the default docutils transform tries to resolve them.

overrides sphinx.transforms.CitationReferences, in order to propogate the classes of the citation_reference node to the pending_xref node

apply(**kwargs)

Override to apply the transform to the document tree.

default_priority = 618

ipypublish.sphinx.gls.transforms.node_text_transform(node, transform)

Apply transformation to all Text nodes within node.

ipypublish.sphinx.gls.transforms.transform_url_command(textnode)

Convert ‘\url{…}’ into a proper docutils hyperlink.