On this page

• Examples
  • Manual function
  • sphinx_artisan_theme module

API documentation

Examples

Manual function

send_message(sender, priority)

Send a message to a recipient

Parameters:

• sender (str) – The person sending the message

• priority (int) – The priority of the message, can be a number 1-5

Returns:

the message id

Return type:

int

Raises:

ValueError – if the message_body exceeds 160 characters

sphinx_artisan_theme module

A sphinx theme for Artisan of Code projects.

Functions:

setup(app)

Registration callback.

setup(app)

Registration callback.

Setup the extension with sphinx

Parameters:

app (Sphinx) – the sphinx application

Return type:

dict[str, Any]