diff --git a/docs/pybind11.md b/docs/pybind11.md index 7cf41a46..4884a7c0 100644 --- a/docs/pybind11.md +++ b/docs/pybind11.md @@ -1,8 +1,15 @@ -# pybind11 user guide +--- +icon: log +title: 'pybind11 User Guide' +order: 21 +--- ## Quick Start -remember to use `py::scoped_interpreter guard{}` to start the interpreter before using any Python objects. Or explicitly call `py::interpreter::initialize()` and `py::interpreter::finalize()`. +pkpy provides a [pybind11](https://pybind11.readthedocs.io/en/stable/) compatible layer which allows users to do convenient bindings. + +To begin with, use `py::scoped_interpreter guard{}` to start the interpreter before using any Python objects. +Or explicitly call `py::interpreter::initialize()` and `py::interpreter::finalize()`. ### module @@ -281,4 +288,4 @@ Need further discussion. - in-place operators, such as `+=`, `-=`, `*=`, etc., are not supported in pocketpy. -- thre return value of `globals` is immutable in pocketpy. \ No newline at end of file +- thre return value of `globals` is immutable in pocketpy.