pyo3/guide/src/SUMMARY.md

# Summary

[Introduction](index.md)

---

- [Getting started](getting_started.md)
- [Python modules](module.md)
- [Python functions](function.md)
  - [Function signatures](function/signature.md)
  - [Error handling](function/error_handling.md)
- [Python classes](class.md)
  - [Class customizations](class/protocols.md)
    - [Basic object customization](class/object.md)
    - [Emulating numeric types](class/numeric.md)
    - [Emulating callable objects](class/call.md)
- [Type conversions](conversions.md)
  - [Mapping of Rust types to Python types](conversions/tables.md)
  - [Conversion traits](conversions/traits.md)
- [Python exceptions](exception.md)
- [Calling Python from Rust](python_from_rust.md)
- [Using `async` and `await`](async-await.md)
- [GIL, mutability and object types](types.md)
- [Parallelism](parallelism.md)
- [Debugging](debugging.md)
- [Features reference](features.md)
- [Memory management](memory.md)
- [Performance](performance.md)
- [Advanced topics](advanced.md)
- [Building and distribution](building_and_distribution.md)
  - [Supporting multiple Python versions](building_and_distribution/multiple_python_versions.md)
- [Useful crates](ecosystem.md)
  - [Logging](ecosystem/logging.md)
  - [Using `async` and `await`](ecosystem/async-await.md)
- [FAQ and troubleshooting](faq.md)

---

[Appendix A: Migration guide](migration.md)
[Appendix B: Trait bounds](trait_bounds.md)
[Appendix C: Python typing hints](python_typing_hints.md)
[CHANGELOG](changelog.md)

---

[Contributing](contributing.md)
User guide documentaion (#37) User guide documentaion 2017-06-18 02:02:02 +00:00			`# Summary`

Add introduction to guide 2020-08-30 09:08:58 +00:00			`[Introduction](index.md)`

			`---`

guide: use sentence case, move function signatures to own section 2022-08-21 13:10:49 +00:00			`- [Getting started](getting_started.md)`
			`- [Python modules](module.md)`
			`- [Python functions](function.md)`
			`- [Function signatures](function/signature.md)`
guide: additional detail on how to handle foreign errors 2022-08-21 15:23:34 +00:00			`- [Error handling](function/error_handling.md)`
guide: use sentence case, move function signatures to own section 2022-08-21 13:10:49 +00:00			`- [Python classes](class.md)`
Start splitting long guide pages into subchapters 2020-09-01 21:40:41 +00:00			`- [Class customizations](class/protocols.md)`
Add numeric and object protocol examples 2022-02-23 09:08:42 +00:00			`- [Basic object customization](class/object.md)`
			`- [Emulating numeric types](class/numeric.md)`
Organize examples + add __call__ example (#2043) * Add decorator example crate and split off chapter * Move not-examples to their own folder * Add some readme's * Make black happy * Make clippy happy * Add decorator example crate and split off chapter * Fix ci * Add empty workspace key * Try fix ci * fix ci * reuse target dir for examples CI * add pytests folder to makefile recipes * fix ci, try 2 * add missing pyproject.toml * remove TOX_TESTENV_PASSENV from Makefile Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com> 2021-12-15 00:45:26 +00:00			`- [Emulating callable objects](class/call.md)`
guide: use sentence case, move function signatures to own section 2022-08-21 13:10:49 +00:00			`- [Type conversions](conversions.md)`
docs: fix typos 2023-12-07 09:10:15 +00:00			`- [Mapping of Rust types to Python types](conversions/tables.md)`
			`- [Conversion traits](conversions/traits.md)`
guide: use sentence case, move function signatures to own section 2022-08-21 13:10:49 +00:00			`- [Python exceptions](exception.md)`
guide: fixes and some minor additions (#802) * guide: fixes and some minor additions I went through the guide and fixed some grammar/consistency issues, and added some wording where I thought it appropriate. I also reordered the chapters to what I feel is a more natural flow of concepts. * Apply suggestions from code review and fix tests Co-Authored-By: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com> Co-Authored-By: David Hewitt <1939362+davidhewitt@users.noreply.github.com> Co-authored-by: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com> Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com> 2020-03-13 13:53:49 +00:00			`- [Calling Python from Rust](python_from_rust.md)`
feat: support `async fn` in macros with coroutine implementation 2023-10-23 12:43:12 +00:00			- [Using `async` and `await`](async-await.md)
guide: add type overview (#801) * book: add type overview fixes #789 Co-Authored-By: David Hewitt <1939362+davidhewitt@users.noreply.github.com> Co-Authored-By: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com> * Add concrete pointer types to the list. * Add suggestions from @kngwyu Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com> Co-authored-by: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com> 2020-03-16 13:57:27 +00:00			`- [GIL, mutability and object types](types.md)`
Add Documentation on build and linker args 2018-11-15 19:35:16 +00:00			`- [Parallelism](parallelism.md)`
			`- [Debugging](debugging.md)`
guide: use sentence case, move function signatures to own section 2022-08-21 13:10:49 +00:00			`- [Features reference](features.md)`
			`- [Memory management](memory.md)`
Start adding a performance section to the guide. 2023-07-09 09:52:04 +00:00			`- [Performance](performance.md)`
guide: use sentence case, move function signatures to own section 2022-08-21 13:10:49 +00:00			`- [Advanced topics](advanced.md)`
			`- [Building and distribution](building_and_distribution.md)`
pyo3-build-config: docs wip 2021-05-21 07:34:51 +00:00			`- [Supporting multiple Python versions](building_and_distribution/multiple_python_versions.md)`
guide: use sentence case, move function signatures to own section 2022-08-21 13:10:49 +00:00			`- [Useful crates](ecosystem.md)`
guide: organise more chapters into sublevels 2021-01-24 12:27:42 +00:00			`- [Logging](ecosystem/logging.md)`
guide: use sentence case, move function signatures to own section 2022-08-21 13:10:49 +00:00			- [Using `async` and `await`](ecosystem/async-await.md)
			`- [FAQ and troubleshooting](faq.md)`
Add introduction to guide 2020-08-30 09:08:58 +00:00
			`---`

guide: use sentence case, move function signatures to own section 2022-08-21 13:10:49 +00:00			`[Appendix A: Migration guide](migration.md)`
remove comparison to rust-cpython 2023-10-15 20:55:36 +00:00			`[Appendix B: Trait bounds](trait_bounds.md)`
			`[Appendix C: Python typing hints](python_typing_hints.md)`
Add CHANGELOG to the guide 2020-09-05 13:44:39 +00:00			`[CHANGELOG](changelog.md)`
guide: add contributing page (#2442) Co-authored-by: messense <messense@icloud.com> 2022-06-08 13:30:11 +00:00
			`---`

			`[Contributing](contributing.md)`