parse_event

plasmapy_sphinx.directives.event.parse_event(env, sig, signode)

Used to set up the event directive and role for documenting Sphinx events. Taken from the conf.py file of Sphinx’s documentation.

Parameters
  • env (sphinx.environment.BuildEnvironment) – Instance of the Sphinx’s build environment.

  • sig (str) –

    The “signature” given the the event directive or role. For example,

    .. event:: foo(bar)
    
    :event:`foo`
    

    in the directive case foo(bar) would be the signature and in the role case foo would be the signature.

  • signode (sphinx.addnodes.desc_signature) – A docutils Node for the object signatures.