Blame - docs/reference.rst - platform/external/python/pybind11

blob: d9dc961c2dd4f2cec5afb04a349c0728f9955d9b [file] [log] [blame]

Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	1	.. _reference:
				2
Wenzel Jakob	9329669	2015-10-13 23:21:54 +0200	[diff] [blame]	3	.. warning::
				4
				5	Please be advised that the reference documentation discussing pybind11
				6	internals is currently incomplete. Please refer to the previous sections
Wenzel Jakob	8f4eb00	2015-10-15 18:13:33 +0200	[diff] [blame]	7	and the pybind11 header files for the nitty gritty details.
Wenzel Jakob	9329669	2015-10-13 23:21:54 +0200	[diff] [blame]	8
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	9	Reference
				10	#########
				11
				12	Macros
				13	======
				14
Dean Moldovan	443ab59	2017-04-24 01:51:44 +0200	[diff] [blame]	15	.. doxygendefine:: PYBIND11_MODULE
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	16
				17	.. _core_types:
				18
				19	Convenience classes for arbitrary Python types
				20	==============================================
				21
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	22	Common member functions
				23	-----------------------
				24
				25	.. doxygenclass:: object_api
				26	:members:
				27
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	28	Without reference counting
				29	--------------------------
				30
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	31	.. doxygenclass:: handle
				32	:members:
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	33
				34	With reference counting
				35	-----------------------
				36
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	37	.. doxygenclass:: object
				38	:members:
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	39
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	40	.. doxygenfunction:: reinterpret_borrow
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	41
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	42	.. doxygenfunction:: reinterpret_steal
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	43
				44	Convenience classes for specific Python types
				45	=============================================
				46
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	47	.. doxygenclass:: module
				48	:members:
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	49
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	50	.. doxygengroup:: pytypes
				51	:members:
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	52
				53	.. _extras:
				54
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	55	Passing extra arguments to ``def`` or ``class_``
				56	================================================
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	57
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	58	.. doxygengroup:: annotations
				59	:members:
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	60
Dean Moldovan	22c413b	2017-03-30 00:20:42 +0200	[diff] [blame]	61	Embedding the interpreter
				62	=========================
				63
				64	.. doxygendefine:: PYBIND11_EMBEDDED_MODULE
				65
				66	.. doxygenfunction:: initialize_interpreter
				67
				68	.. doxygenfunction:: finalize_interpreter
				69
				70	.. doxygenclass:: scoped_interpreter
				71
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	72	Python build-in functions
				73	=========================
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	74
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	75	.. doxygengroup:: python_builtins
				76	:members:
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	77
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	78	Exceptions
				79	==========
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	80
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	81	.. doxygenclass:: error_already_set
				82	:members:
Wenzel Jakob	9329669	2015-10-13 23:21:54 +0200	[diff] [blame]	83
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	84	.. doxygenclass:: builtin_exception
				85	:members:
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	86
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	87
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	88	Literals
				89	========
Wenzel Jakob	28f98aa	2015-10-13 02:57:16 +0200	[diff] [blame]	90
Dean Moldovan	57a9bbc	2017-01-31 16:54:08 +0100	[diff] [blame]	91	.. doxygennamespace:: literals