Skip to content

Commit 03bbad4

Browse files
author
gerrymanoim
authored
Merge pull request #182 from quantopian/more-tutorial-content
DOC: more tutorial content
2 parents c0e2e8e + ae9894f commit 03bbad4

File tree

13 files changed

+702
-258
lines changed

13 files changed

+702
-258
lines changed

Diff for: docs/source/appendix.rst

+46-28
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,11 @@
22
Appendix
33
========
44

5-
Python Object References
6-
========================
7-
8-
.. doxygenclass:: py::owned_ref
9-
:members:
10-
:undoc-members:
5+
C++
6+
===
117

128
``<libpy/abi.h>``
13-
=================
9+
-----------------
1410

1511
.. doxygenstruct:: py::abi::abi_version
1612
:undoc-members:
@@ -22,7 +18,7 @@ Python Object References
2218
.. doxygenfunction:: py::abi::ensure_compatible_libpy_abi
2319

2420
``<libpy/any.h>``
25-
=================
21+
-----------------
2622

2723
.. doxygenclass:: py::any_vtable
2824
:members:
@@ -43,14 +39,14 @@ Python Object References
4339
.. doxygenfunction:: py::dtype_to_vtable
4440

4541
``<libpy/any_vector.h>``
46-
========================
42+
------------------------
4743

4844
.. doxygenclass:: py::any_vector
4945
:members:
5046
:undoc-members:
5147

5248
``<libpy/autoclass.h>``
53-
=======================
49+
-----------------------
5450

5551
.. doxygenstruct:: py::autoclass
5652
:members:
@@ -62,7 +58,7 @@ Python Object References
6258
:members:
6359

6460
``<libpy/autofunction.h>``
65-
==========================
61+
--------------------------
6662

6763
.. doxygenfunction:: py::autofunction
6864

@@ -86,15 +82,21 @@ Python Object References
8682
.. doxygenclass:: py::dispatch::adapt_argument
8783
:members:
8884

85+
86+
``<libpy/automodule.h>``
87+
------------------------
88+
89+
.. doxygendefine:: LIBPY_AUTOMODULE
90+
8991
``<libpy/borrowed_ref.h>``
90-
==========================
92+
--------------------------
9193

9294
.. doxygenclass:: py::borrowed_ref
9395
:members:
9496
:undoc-members:
9597

9698
``<libpy/buffer.h>``
97-
====================
99+
--------------------
98100

99101
.. doxygentypedef:: py::buffer
100102

@@ -107,12 +109,12 @@ Python Object References
107109
.. doxygenfunction:: py::buffer_type_compatible(const py::buffer&)
108110

109111
``<libpy/build_tuple.h>``
110-
=========================
112+
-------------------------
111113

112114
.. doxygenfunction:: py::build_tuple
113115

114116
``<libpy/call_function.h>``
115-
===========================
117+
---------------------------
116118

117119
.. doxygenfunction:: py::call_function
118120

@@ -123,7 +125,7 @@ Python Object References
123125
.. doxygenfunction:: py::call_method_throws
124126

125127
``<libpy/char_sequence.h>``
126-
===========================
128+
---------------------------
127129

128130
.. doxygentypedef:: py::cs::char_sequence
129131

@@ -144,7 +146,7 @@ Python Object References
144146
.. doxygenfunction:: py::cs::join
145147

146148
``<libpy/datetime64.h>``
147-
========================
149+
------------------------
148150

149151
.. doxygenclass:: py::datetime64
150152
:members:
@@ -165,7 +167,7 @@ Python Object References
165167
.. doxygenfunction:: py::chrono::time_since_epoch
166168

167169
``<libpy/demangle.h>``
168-
======================
170+
----------------------
169171

170172
.. doxygenfunction:: py::util::demangle_string(const char*)
171173

@@ -176,14 +178,14 @@ Python Object References
176178
.. doxygenclass:: py::util::demangle_error
177179

178180
``<libpy/dict_range.h>``
179-
========================
181+
------------------------
180182

181183
.. doxygenclass:: py::dict_range
182184
:members:
183185
:undoc-members:
184186

185187
``<libpy/exception.h>``
186-
=======================
188+
-----------------------
187189

188190
.. doxygenclass:: py::exception
189191
:members:
@@ -195,7 +197,7 @@ Python Object References
195197
.. doxygenstruct:: py::dispatch::raise_format
196198

197199
``<libpy/from_object.h>``
198-
=========================
200+
-------------------------
199201

200202
.. doxygenfunction:: py::from_object
201203

@@ -204,7 +206,7 @@ Python Object References
204206
.. doxygenstruct:: py::dispatch::from_object
205207

206208
``<libpy/getattr.h>``
207-
=====================
209+
---------------------
208210

209211
.. doxygenfunction:: py::getattr
210212

@@ -215,13 +217,13 @@ Python Object References
215217
.. doxygenfunction:: py::nested_getattr_throws
216218

217219
``<libpy/gil.h>``
218-
=================
220+
-----------------
219221

220222
.. doxygenstruct:: py::gil
221223
:members:
222224

223225
``<libpy/hash.h>``
224-
==================
226+
------------------
225227

226228
.. doxygenfunction:: py::hash_combine(T, Ts...)
227229

@@ -232,7 +234,7 @@ Python Object References
232234
.. doxygenfunction:: py::hash_buffer
233235

234236
``<libpy/itertools.h>``
235-
=======================
237+
-----------------------
236238

237239
.. doxygenfunction:: py::zip
238240

@@ -241,7 +243,7 @@ Python Object References
241243
.. doxygenfunction:: py::imap
242244

243245
``<libpy/meta.h>``
244-
==================
246+
------------------
245247

246248
.. doxygenstruct:: py::meta::print_t
247249

@@ -258,7 +260,7 @@ Python Object References
258260
.. doxygentypedef:: py::meta::set_diff
259261

260262
``op`` operator function objects
261-
--------------------------------
263+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
262264

263265
Each of these types implements ``operator()`` to defer to the named operator while attempting to preserve all the observable properties of calling the underlying operator directly.
264266

@@ -284,7 +286,7 @@ Each of these types implements ``operator()`` to defer to the named operator whi
284286
.. doxygenstruct:: py::meta::op::inv
285287

286288
``<libpy/ndarray_view.h>``
287-
==========================
289+
--------------------------
288290

289291
.. doxygenclass:: py::ndarray_view
290292
:members:
@@ -296,6 +298,8 @@ Each of these types implements ``operator()`` to defer to the named operator whi
296298

297299
.. doxygentypedef:: py::array_view
298300

301+
.. doxygenfunction:: py::for_each_unordered
302+
299303
Type Erased Views
300304
-----------------
301305

@@ -318,3 +322,17 @@ These partial specializations implement the same protocol as the non type-erased
318322
.. doxygenclass:: py::ndarray_view< any_ref, 1, false >
319323
:members:
320324
:undoc-members:
325+
326+
Python
327+
======
328+
329+
Miscellaneous
330+
-------------
331+
.. autodata:: libpy.version_info
332+
333+
The ABI version of libpy.
334+
335+
Build
336+
-----
337+
338+
.. autoclass:: libpy.build.LibpyExtension

0 commit comments

Comments
 (0)