Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
gaoqiong
pybind11
Commits
6eb11da9
Commit
6eb11da9
authored
Jan 17, 2016
by
Wenzel Jakob
Browse files
Very minor documentation fixes, updated logo
parent
f4671f6a
Changes
9
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
22 additions
and
15 deletions
+22
-15
CMakeLists.txt
CMakeLists.txt
+2
-1
README.md
README.md
+4
-4
docs/basics.rst
docs/basics.rst
+5
-3
docs/classes.rst
docs/classes.rst
+2
-2
docs/cmake.rst
docs/cmake.rst
+2
-1
docs/index.rst
docs/index.rst
+2
-1
docs/intro.rst
docs/intro.rst
+5
-3
docs/pybind11-logo.png
docs/pybind11-logo.png
+0
-0
logo.png
logo.png
+0
-0
No files found.
CMakeLists.txt
View file @
6eb11da9
...
...
@@ -146,7 +146,8 @@ elseif (UNIX)
# 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
# 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
# differently. The solution for Linux and Mac OS is simple: we just don't
...
...
README.md
View file @
6eb11da9


# 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
everything stripped away that isn't relevant for binding generation. The core
header files only require ~
3
K lines of code and depend on Python (2.7 or 3.x)
header files only require ~
2.5
K lines of code and depend on Python (2.7 or 3.x)
and the C++ standard library. This compact implementation was possible thanks
to some of the new C++11 language features (specifically: tuples, lambda
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
equivalent bindings generated by Boost.Python.
-
When supported by the compiler, two new C++14 features (relaxed constexpr
,
return value deduction)
such as
are used to d
o additional work
at compile
-
When supported by the compiler, two new C++14 features (relaxed constexpr
and
return value deduction) are used to d
educe function signatures
at compile
time, leading to smaller binaries.
### License
...
...
docs/basics.rst
View file @
6eb11da9
...
...
@@ -173,7 +173,7 @@ The keyword names also appear in the function signatures within the documentatio
FUNCTIONS
add(...)
Signature : (i: int
32_t
, j: int
32_t
) -> int
32_t
Signature : (i: int, j: int) -> int
A function which adds two numbers
...
...
@@ -209,7 +209,7 @@ The default values also appear within the documentation.
FUNCTIONS
add(...)
Signature : (i: int
32_t
= 1
L
, j: int
32_t
= 2
L
) -> int
32_t
Signature : (i: int = 1, j: int = 2) -> int
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::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 |
+------------------------+--------------------------+-----------------------+
...
...
docs/classes.rst
View file @
6eb11da9
...
...
@@ -240,10 +240,10 @@ The overload signatures are also visible in the method's docstring:
| Methods defined here:
|
| __init__(...)
| Signature : (Pet, str, int
32_t
) -> None
| Signature : (Pet, str, int) -> None
|
| set(...)
| 1. Signature : (Pet, int
32_t
) -> None
| 1. Signature : (Pet, int) -> None
|
| Set the pet's age
|
...
...
docs/cmake.rst
View file @
6eb11da9
...
...
@@ -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.
# 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
# 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
# differently. The solution for Linux and Mac OS is simple: we just don't
...
...
docs/index.rst
View file @
6eb11da9
.. image:: pybind11-logo.png
pybind11 --- Seamless operability between C++11 and Python
==========================================================
Contents:
.. toctree::
...
...
docs/intro.rst
View file @
6eb11da9
.. image:: pybind11-logo.png
About this project
==================
**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
everything stripped away that isn't relevant for binding generation. The core
header files only require ~
3
K lines of code and depend on Python (2.7 or 3.x)
header files only require ~
2.5
K lines of code and depend on Python (2.7 or 3.x)
and the C++ standard library. This compact implementation was possible thanks
to some of the new C++11 language features (specifically: tuples, lambda
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
equivalent bindings generated by Boost.Python.
- When supported by the compiler, two new C++14 features (relaxed constexpr
,
return value deduction)
such as
are used to d
o additional work
at compile
- When supported by the compiler, two new C++14 features (relaxed constexpr
and
return value deduction) are used to d
educe function signatures
at compile
time, leading to smaller binaries.
docs/pybind11-logo.png
0 → 100644
View file @
6eb11da9
57.1 KB
logo.png
deleted
100644 → 0
View file @
f4671f6a
51.7 KB
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment