Directives in the C domain

The domain name is c. See https://www.sphinx-doc.org/en/master/usage/domains/c.html.

PyObject *PyTypeObject.tp_bases

The .. c:member:: directive, showing a struct member.

int my_var

The .. c:var:: directive, showing a variable.

PyObject *PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)

The .. c:function:: directive, showing a function. The signature should be given as in C.

Parameters:

• type – description of the first parameter.

• nitems – description of the second parameter.

Returns:

a result.

Return values:

• NULL – under some conditions.

• NULL – under some other conditions as well.

MY_MACRO

The .. c:macro:: directive, showing a macro, i.e., a C-language #define, without the replacement text.

MY_MACRO_ARGS(arg_list)

The .. c:macro:: directive, showing a macro, i.e., a C-language #define, without the replacement text.

struct MyStruct

The .. c:struct:: directive, showing a struct.

union MyUnion

The .. c:union:: directive, showing a union.

enum MyEnum

The .. c:enum:: directive, showing an enum.

enumerator myEnumerator

The .. c:enumerator:: directive, showing an enumerator.

type my_type

The .. c:type:: directive, showing a type.