summaryrefslogtreecommitdiffstats
path: root/Doc/extending/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/extending/index.rst')
-rw-r--r--Doc/extending/index.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/Doc/extending/index.rst b/Doc/extending/index.rst
new file mode 100644
index 0000000..6e8cf79
--- /dev/null
+++ b/Doc/extending/index.rst
@@ -0,0 +1,34 @@
+.. _extending-index:
+
+##################################################
+ Extending and Embedding the Python Interpreter
+##################################################
+
+:Release: |version|
+:Date: |today|
+
+This document describes how to write modules in C or C++ to extend the Python
+interpreter with new modules. Those modules can define new functions but also
+new object types and their methods. The document also describes how to embed
+the Python interpreter in another application, for use as an extension language.
+Finally, it shows how to compile and link extension modules so that they can be
+loaded dynamically (at run time) into the interpreter, if the underlying
+operating system supports this feature.
+
+This document assumes basic knowledge about Python. For an informal
+introduction to the language, see :ref:`tutorial-index`. :ref:`reference-index`
+gives a more formal definition of the language. :ref:`library-index` documents
+the existing object types, functions and modules (both built-in and written in
+Python) that give the language its wide application range.
+
+For a detailed description of the whole Python/C API, see the separate
+:ref:`c-api-index`.
+
+.. toctree::
+ :maxdepth: 2
+
+ extending.rst
+ newtypes.rst
+ building.rst
+ windows.rst
+ embedding.rst