Events

The following outlines additional events supported by this extension.

Generic events

confluence-publish-attachment (app, docname, key, aid, meta)
Parameters:

  • app – Sphinx

  • docname – str of the document name

  • key – str of the attachment key

  • aid – int of the upload id of the published attachment

  • meta – dict of additional metadata for this event

Emitted when this extension has completed the upload of an attachment.

Added in version 2.8.

confluence-publish-page (app, docname, pid, meta)
Parameters:

  • app – Sphinx

  • docname – str of the document name

  • pid – int of the upload id of the published page

  • meta – dict of additional metadata for this event

Emitted when this extension has completed the upload of a document.

Added in version 2.8.

confluence-publish-point (app, point_url)
Parameters:

  • app – Sphinx

  • point_url – str of the publish point URL

Emitted when this extension prints the “publish point” URL to the standard output stream.

Added in version 2.6.

Advanced events

confluence-publish-override-pageid (app, docname, meta)
Parameters:

  • app – Sphinx

  • docname – str of the document name

  • meta – dict of additional metadata for this event

Returns:

int | None of the new page identifier

Emitted when this extension is about to determine the page identifier to publish a document. A configuration and register this event and return a new identifier to use for a page. If None is returned, the extension will operate in the same manner as if no override was provided.

Added in version 2.8.