Skip to content

Commit 587d5f8

Browse files
Update breathe to 4.26.1, add make_tuple, make_iterator, and make_key_iterator (#2828)
1 parent 9b7bfef commit 587d5f8

File tree

4 files changed

+18
-2
lines changed

4 files changed

+18
-2
lines changed

docs/reference.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,17 @@ Convenience classes for specific Python types
5252
.. doxygengroup:: pytypes
5353
:members:
5454

55+
Convenience functions converting to Python types
56+
================================================
57+
58+
.. doxygenfunction:: make_tuple(Args&&...)
59+
60+
.. doxygenfunction:: make_iterator(Iterator, Sentinel, Extra &&...)
61+
.. doxygenfunction:: make_iterator(Type &, Extra&&...)
62+
63+
.. doxygenfunction:: make_key_iterator(Iterator, Sentinel, Extra &&...)
64+
.. doxygenfunction:: make_key_iterator(Type &, Extra&&...)
65+
5566
.. _extras:
5667

5768
Passing extra arguments to ``def`` or ``class_``
@@ -110,7 +121,6 @@ Exceptions
110121
.. doxygenclass:: builtin_exception
111122
:members:
112123

113-
114124
Literals
115125
========
116126

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
breathe==4.25.1
1+
breathe==4.26.1
22
commonmark==0.9.1
33
recommonmark==0.7.1
44
sphinx==3.3.1

include/pybind11/pybind11.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1890,7 +1890,9 @@ PYBIND11_NAMESPACE_END(detail)
18901890
template <return_value_policy Policy = return_value_policy::reference_internal,
18911891
typename Iterator,
18921892
typename Sentinel,
1893+
#ifndef DOXYGEN_SHOULD_SKIP_THIS // Issue in breathe 4.26.1
18931894
typename ValueType = decltype(*std::declval<Iterator>()),
1895+
#endif
18941896
typename... Extra>
18951897
iterator make_iterator(Iterator first, Sentinel last, Extra &&... extra) {
18961898
using state = detail::iterator_state<Iterator, Sentinel, false, Policy>;
@@ -1919,7 +1921,9 @@ iterator make_iterator(Iterator first, Sentinel last, Extra &&... extra) {
19191921
template <return_value_policy Policy = return_value_policy::reference_internal,
19201922
typename Iterator,
19211923
typename Sentinel,
1924+
#ifndef DOXYGEN_SHOULD_SKIP_THIS // Issue in breathe 4.26.1
19221925
typename KeyType = decltype((*std::declval<Iterator>()).first),
1926+
#endif
19231927
typename... Extra>
19241928
iterator make_key_iterator(Iterator first, Sentinel last, Extra &&... extra) {
19251929
using state = detail::iterator_state<Iterator, Sentinel, true, Policy>;

include/pybind11/pytypes.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,8 +279,10 @@ class object : public handle {
279279
struct borrowed_t { };
280280
struct stolen_t { };
281281

282+
#ifndef DOXYGEN_SHOULD_SKIP_THIS // Issue in breathe 4.26.1
282283
template <typename T> friend T reinterpret_borrow(handle);
283284
template <typename T> friend T reinterpret_steal(handle);
285+
#endif
284286

285287
public:
286288
// Only accessible from derived classes and the reinterpret_* functions

0 commit comments

Comments
 (0)