reference.rst revision 12037:d28054ac6ec9 
1.. _reference:
2
3.. warning::
4
5    Please be advised that the reference documentation discussing pybind11
6    internals is currently incomplete. Please refer to the previous sections
7    and the pybind11 header files for the nitty gritty details.
8
9Reference
10#########
11
12Macros
13======
14
15.. doxygendefine:: PYBIND11_PLUGIN
16
17.. _core_types:
18
19Convenience classes for arbitrary Python types
20==============================================
21
22Common member functions
23-----------------------
24
25.. doxygenclass:: object_api
26    :members:
27
28Without reference counting
29--------------------------
30
31.. doxygenclass:: handle
32    :members:
33
34With reference counting
35-----------------------
36
37.. doxygenclass:: object
38    :members:
39
40.. doxygenfunction:: reinterpret_borrow
41
42.. doxygenfunction:: reinterpret_steal
43
44Convenience classes for specific Python types
45=============================================
46
47.. doxygenclass:: module
48    :members:
49
50.. doxygengroup:: pytypes
51    :members:
52
53.. _extras:
54
55Passing extra arguments to ``def`` or ``class_``
56================================================
57
58.. doxygengroup:: annotations
59    :members:
60
61Python build-in functions
62=========================
63
64.. doxygengroup:: python_builtins
65    :members:
66
67Exceptions
68==========
69
70.. doxygenclass:: error_already_set
71    :members:
72
73.. doxygenclass:: builtin_exception
74    :members:
75
76
77Literals
78========
79
80.. doxygennamespace:: literals
81