reference.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  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. Macros
  10. ======
  11. .. doxygendefine:: PYBIND11_MODULE
  12. .. _core_types:
  13. Convenience classes for arbitrary Python types
  14. ==============================================
  15. Common member functions
  16. -----------------------
  17. .. doxygenclass:: object_api
  18. :members:
  19. Without reference counting
  20. --------------------------
  21. .. doxygenclass:: handle
  22. :members:
  23. With reference counting
  24. -----------------------
  25. .. doxygenclass:: object
  26. :members:
  27. .. doxygenfunction:: reinterpret_borrow
  28. .. doxygenfunction:: reinterpret_steal
  29. Convenience classes for specific Python types
  30. =============================================
  31. .. doxygenclass:: module
  32. :members:
  33. .. doxygengroup:: pytypes
  34. :members:
  35. .. _extras:
  36. Passing extra arguments to ``def`` or ``class_``
  37. ================================================
  38. .. doxygengroup:: annotations
  39. :members:
  40. Embedding the interpreter
  41. =========================
  42. .. doxygendefine:: PYBIND11_EMBEDDED_MODULE
  43. .. doxygenfunction:: initialize_interpreter
  44. .. doxygenfunction:: finalize_interpreter
  45. .. doxygenclass:: scoped_interpreter
  46. Redirecting C++ streams
  47. =======================
  48. .. doxygenclass:: scoped_ostream_redirect
  49. .. doxygenclass:: scoped_estream_redirect
  50. .. doxygenfunction:: add_ostream_redirect
  51. Python built-in functions
  52. =========================
  53. .. doxygengroup:: python_builtins
  54. :members:
  55. Exceptions
  56. ==========
  57. .. doxygenclass:: error_already_set
  58. :members:
  59. .. doxygenclass:: builtin_exception
  60. :members:
  61. Literals
  62. ========
  63. .. doxygennamespace:: literals