mirror of
https://github.com/pybind/pybind11.git
synced 2024-11-22 05:05:11 +00:00
Very minor documentation fixes, updated logo
This commit is contained in:
parent
f4671f6a04
commit
6eb11da94a
@ -146,7 +146,8 @@ elseif (UNIX)
|
|||||||
# that's statically linked into an application like Blender or Maya.
|
# that's statically linked into an application like Blender or Maya.
|
||||||
# If we link our plugin library against the OS Python here and import it
|
# If we link our plugin library against the OS Python here and import it
|
||||||
# into Blender or Maya later on, this will cause segfaults when multiple
|
# into Blender or Maya later on, this will cause segfaults when multiple
|
||||||
# conflicting Python instances are active at the same time.
|
# conflicting Python instances are active at the same time (even when they
|
||||||
|
# are of the same version).
|
||||||
|
|
||||||
# Windows is not affected by this issue since it handles DLL imports
|
# Windows is not affected by this issue since it handles DLL imports
|
||||||
# differently. The solution for Linux and Mac OS is simple: we just don't
|
# differently. The solution for Linux and Mac OS is simple: we just don't
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
![pybind11 logo](https://github.com/wjakob/pybind11/raw/master/logo.png)
|
![pybind11 logo](https://github.com/wjakob/pybind11/raw/master/docs/pybind11-logo.png)
|
||||||
|
|
||||||
# pybind11 — Seamless operability between C++11 and Python
|
# pybind11 — Seamless operability between C++11 and Python
|
||||||
|
|
||||||
@ -23,7 +23,7 @@ become an excessively large and unnecessary dependency.
|
|||||||
|
|
||||||
Think of this library as a tiny self-contained version of Boost.Python with
|
Think of this library as a tiny self-contained version of Boost.Python with
|
||||||
everything stripped away that isn't relevant for binding generation. The core
|
everything stripped away that isn't relevant for binding generation. The core
|
||||||
header files only require ~3K lines of code and depend on Python (2.7 or 3.x)
|
header files only require ~2.5K lines of code and depend on Python (2.7 or 3.x)
|
||||||
and the C++ standard library. This compact implementation was possible thanks
|
and the C++ standard library. This compact implementation was possible thanks
|
||||||
to some of the new C++11 language features (specifically: tuples, lambda
|
to some of the new C++11 language features (specifically: tuples, lambda
|
||||||
functions and variadic templates). Since its creation, this library has grown
|
functions and variadic templates). Since its creation, this library has grown
|
||||||
@ -74,8 +74,8 @@ In addition to the core functionality, pybind11 provides some extra goodies:
|
|||||||
- Binaries are generally smaller by a factor of 2 or more compared to
|
- Binaries are generally smaller by a factor of 2 or more compared to
|
||||||
equivalent bindings generated by Boost.Python.
|
equivalent bindings generated by Boost.Python.
|
||||||
|
|
||||||
- When supported by the compiler, two new C++14 features (relaxed constexpr,
|
- When supported by the compiler, two new C++14 features (relaxed constexpr and
|
||||||
return value deduction) such as are used to do additional work at compile
|
return value deduction) are used to deduce function signatures at compile
|
||||||
time, leading to smaller binaries.
|
time, leading to smaller binaries.
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
@ -173,7 +173,7 @@ The keyword names also appear in the function signatures within the documentatio
|
|||||||
|
|
||||||
FUNCTIONS
|
FUNCTIONS
|
||||||
add(...)
|
add(...)
|
||||||
Signature : (i: int32_t, j: int32_t) -> int32_t
|
Signature : (i: int, j: int) -> int
|
||||||
|
|
||||||
A function which adds two numbers
|
A function which adds two numbers
|
||||||
|
|
||||||
@ -209,7 +209,7 @@ The default values also appear within the documentation.
|
|||||||
|
|
||||||
FUNCTIONS
|
FUNCTIONS
|
||||||
add(...)
|
add(...)
|
||||||
Signature : (i: int32_t = 1L, j: int32_t = 2L) -> int32_t
|
Signature : (i: int = 1, j: int = 2) -> int
|
||||||
|
|
||||||
A function which adds two numbers
|
A function which adds two numbers
|
||||||
|
|
||||||
@ -253,7 +253,9 @@ as arguments and return values, refer to the section on binding :ref:`classes`.
|
|||||||
+------------------------+--------------------------+-----------------------+
|
+------------------------+--------------------------+-----------------------+
|
||||||
| std::vector<T> | STL dynamic array | pybind11/stl.h |
|
| std::vector<T> | STL dynamic array | pybind11/stl.h |
|
||||||
+------------------------+--------------------------+-----------------------+
|
+------------------------+--------------------------+-----------------------+
|
||||||
| std::map<T1, T2> | STL dynamic maps | pybind11/stl.h |
|
| std::map<T1, T2> | STL ordered map | pybind11/stl.h |
|
||||||
|
+------------------------+--------------------------+-----------------------+
|
||||||
|
| std::set<T> | STL ordered set | pybind11/stl.h |
|
||||||
+------------------------+--------------------------+-----------------------+
|
+------------------------+--------------------------+-----------------------+
|
||||||
| std::function<...> | STL polymorphic function | pybind11/functional.h |
|
| std::function<...> | STL polymorphic function | pybind11/functional.h |
|
||||||
+------------------------+--------------------------+-----------------------+
|
+------------------------+--------------------------+-----------------------+
|
||||||
|
@ -240,10 +240,10 @@ The overload signatures are also visible in the method's docstring:
|
|||||||
| Methods defined here:
|
| Methods defined here:
|
||||||
|
|
|
|
||||||
| __init__(...)
|
| __init__(...)
|
||||||
| Signature : (Pet, str, int32_t) -> None
|
| Signature : (Pet, str, int) -> None
|
||||||
|
|
|
|
||||||
| set(...)
|
| set(...)
|
||||||
| 1. Signature : (Pet, int32_t) -> None
|
| 1. Signature : (Pet, int) -> None
|
||||||
|
|
|
|
||||||
| Set the pet's age
|
| Set the pet's age
|
||||||
|
|
|
|
||||||
|
@ -100,7 +100,8 @@ and that the pybind11 repository is located in a subdirectory named :file:`pybin
|
|||||||
# that's statically linked into an application like Blender or Maya.
|
# that's statically linked into an application like Blender or Maya.
|
||||||
# If we link our plugin library against the OS Python here and import it
|
# If we link our plugin library against the OS Python here and import it
|
||||||
# into Blender or Maya later on, this will cause segfaults when multiple
|
# into Blender or Maya later on, this will cause segfaults when multiple
|
||||||
# conflicting Python instances are active at the same time.
|
# conflicting Python instances are active at the same time (even when they
|
||||||
|
# are of the same version).
|
||||||
|
|
||||||
# Windows is not affected by this issue since it handles DLL imports
|
# Windows is not affected by this issue since it handles DLL imports
|
||||||
# differently. The solution for Linux and Mac OS is simple: we just don't
|
# differently. The solution for Linux and Mac OS is simple: we just don't
|
||||||
|
@ -1,7 +1,8 @@
|
|||||||
|
.. image:: pybind11-logo.png
|
||||||
|
|
||||||
pybind11 --- Seamless operability between C++11 and Python
|
pybind11 --- Seamless operability between C++11 and Python
|
||||||
==========================================================
|
==========================================================
|
||||||
|
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. image:: pybind11-logo.png
|
||||||
|
|
||||||
About this project
|
About this project
|
||||||
==================
|
==================
|
||||||
**pybind11** is a lightweight header-only library that exposes C++ types in Python
|
**pybind11** is a lightweight header-only library that exposes C++ types in Python
|
||||||
@ -18,7 +20,7 @@ become an excessively large and unnecessary dependency.
|
|||||||
|
|
||||||
Think of this library as a tiny self-contained version of Boost.Python with
|
Think of this library as a tiny self-contained version of Boost.Python with
|
||||||
everything stripped away that isn't relevant for binding generation. The core
|
everything stripped away that isn't relevant for binding generation. The core
|
||||||
header files only require ~3K lines of code and depend on Python (2.7 or 3.x)
|
header files only require ~2.5K lines of code and depend on Python (2.7 or 3.x)
|
||||||
and the C++ standard library. This compact implementation was possible thanks
|
and the C++ standard library. This compact implementation was possible thanks
|
||||||
to some of the new C++11 language features (specifically: tuples, lambda
|
to some of the new C++11 language features (specifically: tuples, lambda
|
||||||
functions and variadic templates). Since its creation, this library has grown
|
functions and variadic templates). Since its creation, this library has grown
|
||||||
@ -68,6 +70,6 @@ In addition to the core functionality, pybind11 provides some extra goodies:
|
|||||||
- Binaries are generally smaller by a factor of 2 or more compared to
|
- Binaries are generally smaller by a factor of 2 or more compared to
|
||||||
equivalent bindings generated by Boost.Python.
|
equivalent bindings generated by Boost.Python.
|
||||||
|
|
||||||
- When supported by the compiler, two new C++14 features (relaxed constexpr,
|
- When supported by the compiler, two new C++14 features (relaxed constexpr and
|
||||||
return value deduction) such as are used to do additional work at compile
|
return value deduction) are used to deduce function signatures at compile
|
||||||
time, leading to smaller binaries.
|
time, leading to smaller binaries.
|
||||||
|
BIN
docs/pybind11-logo.png
Normal file
BIN
docs/pybind11-logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 57 KiB |
Loading…
Reference in New Issue
Block a user