From 16ea4ffdd425ecf410a9aaf73ceac47154eb28b0 Mon Sep 17 00:00:00 2001 From: Peter Alexander Date: Thu, 1 Oct 2009 06:01:33 -0400 Subject: [PATCH] couple of fixes --- src/compilation.rst | 1 - src/extension_types.rst | 1 - src/interfacing_with_other_code.rst | 1 - src/language_basics.rst | 50 +++++++++++++++++------------ src/limitations.rst | 1 - src/overview.rst | 1 - src/special_mention.rst | 1 - 7 files changed, 29 insertions(+), 27 deletions(-) diff --git a/src/compilation.rst b/src/compilation.rst index 0471dac2..3c85fa8c 100644 --- a/src/compilation.rst +++ b/src/compilation.rst @@ -11,7 +11,6 @@ Compilation There are several ways to compile cython code. .. contents:: - :depth: 2 :local: diff --git a/src/extension_types.rst b/src/extension_types.rst index 86626994..0e50beb0 100644 --- a/src/extension_types.rst +++ b/src/extension_types.rst @@ -7,7 +7,6 @@ Extention Types *************** .. contents:: - :depth: 2 :local: ========== diff --git a/src/interfacing_with_other_code.rst b/src/interfacing_with_other_code.rst index 0cc7f230..b3176df9 100644 --- a/src/interfacing_with_other_code.rst +++ b/src/interfacing_with_other_code.rst @@ -7,7 +7,6 @@ Interfacing with Other Code *************************** .. contents:: - :depth: 2 :local: == diff --git a/src/language_basics.rst b/src/language_basics.rst index cffae0f9..57b4e2be 100644 --- a/src/language_basics.rst +++ b/src/language_basics.rst @@ -17,35 +17,37 @@ Cython File Types ================= There are three file types in cython: -* Definition files carry the `.pxd` suffix -* Implementation files carry the `'.pyx suffix -* Include files which carry the `.pxi` suffix +* Definition files carry a `.pxd` suffix +* Implementation files carry a `.pyx` suffix +* Include files which carry a `.pxi` suffix +.. contents:: + :local: -Definition -========== +Definition File +=============== What can it contain? -------------------- - * Any kind of C type declaration. - * `extern` C function or variable decarations. - * Module implementation declarations as well as definition parts of extension types. - * This also is a convenient place to put all declarations of functions, etc., for an - **external library** +* Any kind of C type declaration. +* `extern` C function or variable decarations. +* Declarations for module implementations. +* The definition parts of **extension types**. +* All declarations of functions, etc., for an **external library** What can't it contain? ---------------------- - * Any non-extern C variable declaration. - * Implementations of C or Python functions. - * Python class definitions - * Python executable statements. - * Any declaration that is defined as **public** to make it accessible to other Cython modules. +* Any non-extern C variable declaration. +* Implementations of C or Python functions. +* Python class definitions +* Python executable statements. +* Any declaration that is defined as **public** to make it accessible to other Cython modules. - * This is not necessary, as it is automatic. - * a **public** declaration is only needed to make it accessible to **external C code**. + * This is not necessary, as it is automatic. + * a **public** declaration is only needed to make it accessible to **external C code**. What else? ---------- @@ -68,8 +70,8 @@ compilation order -Implementation -=============== +Implementation File +=================== What can it contain? -------------------- @@ -83,8 +85,8 @@ What can't it contain? already defined else where... **more on this later** -Include -======= +Include File +============ What can it contain? -------------------- @@ -105,6 +107,9 @@ How do I use it? Data Typing =========== +.. contents:: + :local: + Grouping ======== @@ -129,6 +134,9 @@ Statements and Expressions Functions ========= +.. contents:: + :local: + Callable from Python ===================== diff --git a/src/limitations.rst b/src/limitations.rst index 84bd0e03..b1aded75 100644 --- a/src/limitations.rst +++ b/src/limitations.rst @@ -7,5 +7,4 @@ Limitations *********** .. contents:: - :depth: 2 :local: diff --git a/src/overview.rst b/src/overview.rst index 82e14a1e..54787220 100644 --- a/src/overview.rst +++ b/src/overview.rst @@ -7,7 +7,6 @@ Overview ******** .. contents:: - :depth: 2 :local: =============== diff --git a/src/special_mention.rst b/src/special_mention.rst index 3827e9d6..eaf28751 100644 --- a/src/special_mention.rst +++ b/src/special_mention.rst @@ -8,5 +8,4 @@ Special Mention *************** .. contents:: - :depth: 2 :local: -- 2.26.2