Zengtudor/pybind11
1
0
Fork 0
mirror of https://github.com/pybind/pybind11.git synced 2024-11-26 07:02:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

minor doc update

Browse Source
This commit is contained in:
Wenzel Jakob 2015-10-18 14:48:24 +02:00
parent 10e62e168b
commit 7641c1dd11
3 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -5,7 +5,7 @@
[![Build Status](https://travis-ci.org/wjakob/pybind11.svg?branch=master)](https://travis-ci.org/wjakob/pybind11) [![Build Status](https://travis-ci.org/wjakob/pybind11.svg?branch=master)](https://travis-ci.org/wjakob/pybind11)
[![Documentation Status](https://readthedocs.org/projects/pybind11/badge/?version=latest)](http://pybind11.readthedocs.org/en/latest/?badge=latest) [![Documentation Status](https://readthedocs.org/projects/pybind11/badge/?version=latest)](http://pybind11.readthedocs.org/en/latest/?badge=latest)
**pybind11** is a lightweight header library that exposes C++ types in Python **pybind11** is a lightweight header-only library that exposes C++ types in Python
and vice versa, mainly to create Python bindings of existing C++ code. Its and vice versa, mainly to create Python bindings of existing C++ code. Its
goals and syntax are similar to the excellent goals and syntax are similar to the excellent
[Boost.Python](http://www.boost.org/doc/libs/1_58_0/libs/python/doc/) library [Boost.Python](http://www.boost.org/doc/libs/1_58_0/libs/python/doc/) library
@ -21,10 +21,10 @@ C++11-compatible compilers are widely available, this heavy machinery has
become an excessively large and unnecessary dependency. 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 whole everything stripped away that isn't relevant for binding generation. The core
codebase requires less than 3000 lines of code and only depends on Python (2.7 header files only require ~2K lines of code and depend on Python (2.7 or 3.x)
or 3.x) and the C++ standard library. This compact implementation was possible and the C++ standard library. This compact implementation was possible thanks
thanks to some of the new C++11 language features (tuples, lambda functions and to some of the new C++11 language features (tuples, lambda functions and
variadic templates). Since its creation, this library has grown beyond variadic templates). Since its creation, this library has grown beyond
Boost.Python in many ways, leading to dramatically simpler binding code in many Boost.Python in many ways, leading to dramatically simpler binding code in many
common situations. common situations.
@ -67,4 +67,5 @@ In addition to the core functionality, pybind11 provides some extra goodies:
- Python's slice-based access and assignment operations can be supported with - Python's slice-based access and assignment operations can be supported with
just a few lines of code. just a few lines of code.
- Everything is contained in just a few header files; there no need to link
against any additional libraries.

4
docs/index.rst
View File

@ -1,5 +1,5 @@
Welcome to pybind11's documentation! pybind11 --- Seamless operability between C++11 and Python
==================================== ==========================================================
Contents: Contents:

12
docs/intro.rst
View File

@ -1,6 +1,6 @@
About this project About this project
================== ==================
**pybind11** is a lightweight header library that exposes C++ types in Python **pybind11** is a lightweight header-only library that exposes C++ types in Python
and vice versa, mainly to create Python bindings of existing C++ code. Its and vice versa, mainly to create Python bindings of existing C++ code. Its
goals and syntax are similar to the excellent `Boost.Python`_ library by David goals and syntax are similar to the excellent `Boost.Python`_ library by David
Abrahams: to minimize boilerplate code in traditional extension modules by Abrahams: to minimize boilerplate code in traditional extension modules by
@ -17,10 +17,10 @@ C++11-compatible compilers are widely available, this heavy machinery has
become an excessively large and unnecessary dependency. 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 whole everything stripped away that isn't relevant for binding generation. The core
codebase requires less than 3000 lines of code and only depends on Python (2.7 header files only require ~2K lines of code and depend on Python (2.7 or 3.x)
or 3.x) and the C++ standard library. This compact implementation was possible and the C++ standard library. This compact implementation was possible thanks
thanks to some of the new C++11 language features (tuples, lambda functions and to some of the new C++11 language features (tuples, lambda functions and
variadic templates). Since its creation, this library has grown beyond variadic templates). Since its creation, this library has grown beyond
Boost.Python in many ways, leading to dramatically simpler binding code in many Boost.Python in many ways, leading to dramatically simpler binding code in many
common situations. common situations.
@ -62,3 +62,5 @@ In addition to the core functionality, pybind11 provides some extra goodies:
- Python's slice-based access and assignment operations can be supported with - Python's slice-based access and assignment operations can be supported with
just a few lines of code. just a few lines of code.
- Everything is contained in just a few header files; there no need to link
against any additional libraries.