pybind11/docs
Tim Ohliger 1d09fc8300
Option for arg/return type hints and correct typing for std::filesystem::path (#5450)
* Added arg/return type handling.

* Added support for nested arg/return type in py::typing::List

* Added support for arg/return type in stl/filesystem

* Added tests for arg/return type in stl/filesystem and py::typing::List

* Added arg/return name to more py::typing classes

* Added arg/return type to Callable[...]

* Added tests for typing container classes (also nested)

* Changed typing classes to avoid using C++14 auto return type deduction.

* Fixed clang-tidy errors.

* Changed Enable to SFINAE

* Added test for Tuple[T, ...]

* Added RealNumber with custom caster for testing typing classes.

* Added tests for Set, Iterable, Iterator, Union, and Optional

* Added tests for Callable

* Fixed Callable with ellipsis test

* Changed TypeGuard/TypeIs to use return type (being the narrower type) + Tests

* Added test for use of fallback type name with stl vector

* Updated documentation.

* Fixed unnecessary constructor call in test.

* Fixed reference counting in example type caster.

* Fixed clang-tidy issues.

* Fix for clang-tidy

* Updated cast method to use pybind11 API rather than Python C API in custom caster example

* Updated load to use pybind11 API rather than Python C API in custom caster example

* Changed test of arg/return name to use pybind11 API instead of Python C API

* Updated code in adcanced/cast example and improved documentation text

* Fixed references in custom type caster docs

* Fixed wrong logical and operator in test

* Fixed wrong logical operator in doc example

* Added comment to test about `float` vs `float | int`

* Updated std::filesystem::path docs in cast/overview section

* Remove one stray dot.

---------

Co-authored-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>
2024-12-08 11:30:49 -08:00
..
_static/css docs: use Furo (#3109) 2022-07-13 10:13:35 -05:00
advanced Option for arg/return type hints and correct typing for std::filesystem::path (#5450) 2024-12-08 11:30:49 -08:00
cmake fix: find_import didn't work properly for classic tools (#2550) 2020-10-05 15:31:00 -04:00
basics.rst docs: clarify requirements for including pybind11 (#5326) 2024-08-22 00:29:21 -04:00
benchmark.py feat: remove Python 3.6 support (#5177) 2024-06-22 00:55:00 -04:00
benchmark.rst ci: GHA basic format & pre-commit (#2309) 2020-07-20 13:35:21 -04:00
changelog.rst docs: update changelog for 2.13.6 (#5372) 2024-09-13 16:59:50 -04:00
classes.rst Warning on comparing wrapper enums with is (#4732) 2023-07-12 08:56:40 -07:00
compiling.rst feat: require CMake 3.15+ (#5304) 2024-08-14 18:21:04 -04:00
conf.py feat: remove Python 3.6 support (#5177) 2024-06-22 00:55:00 -04:00
Doxyfile Python 2 removal part 1: tests (C++ code is intentionally ~untouched) (#3688) 2022-02-10 18:28:08 -08:00
faq.rst Add while True & top method to FAQ. (#5340) 2024-08-27 21:04:48 -07:00
index.rst fix: chapters in PDF again (#2606) 2020-10-18 14:31:28 -04:00
installing.rst docs: add a note about compiling the example (#2737) 2020-12-24 09:51:36 -05:00
limitations.rst docs: remove outdated known limitation. (#5263) 2024-07-23 22:32:39 -04:00
Makefile took a stab at some documentation 2015-10-13 03:16:44 +02:00
pybind11_vs_boost_python1.png documentation improvements 2016-04-28 15:32:07 +02:00
pybind11_vs_boost_python1.svg Much more efficient generation of function signatures, updated docs 2016-01-17 22:31:15 +01:00
pybind11_vs_boost_python2.png documentation improvements 2016-04-28 15:32:07 +02:00
pybind11_vs_boost_python2.svg Much more efficient generation of function signatures, updated docs 2016-01-17 22:31:15 +01:00
pybind11-logo.png docs: use Furo (#3109) 2022-07-13 10:13:35 -05:00
reference.rst feat: reapply fixed version of #3271 (#3293) 2021-09-23 15:06:07 -04:00
release.rst chore: prepare 2.12.0 (#5070) 2024-03-27 18:09:06 -04:00
requirements.in chore: docs and nox bump (#5071) 2024-05-06 12:22:14 -04:00
requirements.txt chore(deps): bump certifi from 2024.2.2 to 2024.7.4 in /docs (#5226) 2024-07-06 12:22:52 -07:00
upgrade.rst Fix incorrect link syntax in upgrade guide (#5434) 2024-11-06 11:21:33 -08:00