You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

91 lines
1.6 KiB

2 months ago
  1. .. _reference:
  2. .. warning::
  3. Please be advised that the reference documentation discussing pybind11
  4. internals is currently incomplete. Please refer to the previous sections
  5. and the pybind11 header files for the nitty gritty details.
  6. Reference
  7. #########
  8. Macros
  9. ======
  10. .. doxygendefine:: PYBIND11_MODULE
  11. .. _core_types:
  12. Convenience classes for arbitrary Python types
  13. ==============================================
  14. Common member functions
  15. -----------------------
  16. .. doxygenclass:: object_api
  17. :members:
  18. Without reference counting
  19. --------------------------
  20. .. doxygenclass:: handle
  21. :members:
  22. With reference counting
  23. -----------------------
  24. .. doxygenclass:: object
  25. :members:
  26. .. doxygenfunction:: reinterpret_borrow
  27. .. doxygenfunction:: reinterpret_steal
  28. Convenience classes for specific Python types
  29. =============================================
  30. .. doxygenclass:: module
  31. :members:
  32. .. doxygengroup:: pytypes
  33. :members:
  34. .. _extras:
  35. Passing extra arguments to ``def`` or ``class_``
  36. ================================================
  37. .. doxygengroup:: annotations
  38. :members:
  39. Embedding the interpreter
  40. =========================
  41. .. doxygendefine:: PYBIND11_EMBEDDED_MODULE
  42. .. doxygenfunction:: initialize_interpreter
  43. .. doxygenfunction:: finalize_interpreter
  44. .. doxygenclass:: scoped_interpreter
  45. Python build-in functions
  46. =========================
  47. .. doxygengroup:: python_builtins
  48. :members:
  49. Exceptions
  50. ==========
  51. .. doxygenclass:: error_already_set
  52. :members:
  53. .. doxygenclass:: builtin_exception
  54. :members:
  55. Literals
  56. ========
  57. .. doxygennamespace:: literals