From a976fd57941dcd11ff8d99bf4679e4326e67fbd1 Mon Sep 17 00:00:00 2001 From: Gerry Manoim Date: Fri, 26 Jun 2020 11:56:54 -0400 Subject: [PATCH] DOC: Add an intorductory note --- README.rst | 2 +- docs/source/index.rst | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e912f971..894f94b7 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,7 @@ .. image:: https://badge.fury.io/py/libpy.svg :target: https://badge.fury.io/py/libpy -Utilities for writing C++ extension modules for CPython. +``libpy`` is a lbrary to help you write amazing Python extensions in C++. ``libpy``makes it easy to expose C++ code to Python. It lets you automatically wrap functions and classes. It is designed for high performance and safety, so using libpy should be both faster and safer than using the C api directly. `Full documentation `_ diff --git a/docs/source/index.rst b/docs/source/index.rst index 29fc4abc..0b1440e3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,6 +1,9 @@ Welcome to libpy's documentation! ================================= +``libpy`` is a lbrary to help you write amazing Python extensions in C++. ``libpy``makes it easy to expose C++ code to Python. It lets you automatically wrap functions and classes. It is designed for high performance and safety, so using libpy should be both faster and safer than using the C api directly. + + .. toctree:: :maxdepth: 2 :caption: Contents: