Skip to content

Commit 9b374b0

Browse files
committed
docs: use more modern solution for Doxygen skipping
1 parent 2f0edcd commit 9b374b0

File tree

3 files changed

+11
-13
lines changed

3 files changed

+11
-13
lines changed

docs/Doxyfile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,5 @@ ALIASES += "endrst=\endverbatim"
1818
QUIET = YES
1919
WARNINGS = YES
2020
WARN_IF_UNDOCUMENTED = NO
21-
PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
22-
PY_MAJOR_VERSION=3 \
21+
PREDEFINED = PY_MAJOR_VERSION=3 \
2322
PYBIND11_NOINLINE

docs/requirements.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
breathe==4.26.1
1+
breathe==4.31.0
22
# docutils 0.17 breaks HTML tags & RTD theme
33
# https://github.com/sphinx-doc/sphinx/issues/9001
4-
docutils==0.16
5-
sphinx==3.3.1
6-
sphinx_rtd_theme==0.5.0
7-
sphinxcontrib-moderncmakedomain==3.17
8-
sphinxcontrib-svg2pdfconverter==1.1.0
4+
sphinx==3.5.4
5+
sphinx_rtd_theme==1.0.0
6+
sphinxcontrib-moderncmakedomain==3.19
7+
sphinxcontrib-svg2pdfconverter==1.1.1

include/pybind11/pytypes.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/*
1+
nn/DOXY/*
22
pybind11/pytypes.h: Convenience wrapper classes for basic Python types
33
44
Copyright (c) 2016 Wenzel Jakob <[email protected]>
@@ -287,10 +287,10 @@ class object : public handle {
287287
struct borrowed_t { };
288288
struct stolen_t { };
289289

290-
#ifndef DOXYGEN_SHOULD_SKIP_THIS // Issue in breathe 4.26.1
290+
/// @cond BROKEN
291291
template <typename T> friend T reinterpret_borrow(handle);
292292
template <typename T> friend T reinterpret_steal(handle);
293-
#endif
293+
/// @endcond
294294

295295
public:
296296
// Only accessible from derived classes and the reinterpret_* functions
@@ -1717,7 +1717,7 @@ class memoryview : public object {
17171717
#endif
17181718
};
17191719

1720-
#ifndef DOXYGEN_SHOULD_SKIP_THIS
1720+
/// @cond DUPLICATE
17211721
inline memoryview memoryview::from_buffer(
17221722
void *ptr, ssize_t itemsize, const char* format,
17231723
detail::any_container<ssize_t> shape,
@@ -1745,7 +1745,7 @@ inline memoryview memoryview::from_buffer(
17451745
throw error_already_set();
17461746
return memoryview(object(obj, stolen_t{}));
17471747
}
1748-
#endif // DOXYGEN_SHOULD_SKIP_THIS
1748+
/// @endcond
17491749
/// @} pytypes
17501750

17511751
/// \addtogroup python_builtins

0 commit comments

Comments
 (0)