api-doc.rst

API Documentation

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html

Info Field Lists

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists

A link: send_message.

send_message(sender, recipient, message_body, [priority=1])

Send a message to a recipient

param str sender

The person sending the message

param str recipient

The recipient of the message

param str message_body

The body of the message

param priority

The priority of the message, can be a number 1-5

type priority

integer or None

return

the message id

rtype

int

raises ValueError

if the message_body exceeds 160 characters

raises TypeError

if the message_body is not a basestring

Python

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain

A link: hello_world.

C

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-c-domain

C++

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cpp-domain

Partial specialization.

Full specialization.

A function template.

A specialization thereof.

A templated type alias.

Explicit ref: :cppData::@data::a. Short-hand ref: :cppData::a.

An expression: :cppa * f(a) (or as text: :cppa * f(a)).

A type: :cppconst MySortedContainer<int>& (or as text :cppconst MySortedContainer<int>&).

JavaScript

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-javascript-domain

reStructuredText

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-restructuredtext-domain

The Standard Domain

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-standard-domain

Program Options

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-option

A link: rm -r.

rm

-r

Work recursively.

Environment Variables

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-envvar

A link: ENV_VAR.

ENV_VAR

Description of environment variable.

Generic Objects

PAPER

You can set this variable to select a paper size.

SCISSORS

Destroys the aforementioned object.

sphinx.ext.autodoc

A link: insipid_sphinx_theme.setup.

insipid_sphinx_theme

---

example_module

sphinx.ext.autosummary

Warning

With docutils versions older than 0.18, the HTML line breaks in the left column are not working correctly. Make sure to use at least docutils >= 0.18, which is supported since Sphinx version 5.0.

a_very_useful_function TheBestClass

:nosignatures:

a_very_useful_function TheBestClass