pyo3/guide/src/SUMMARY.md

# Summary

[Introduction](index.md)

---

- [Python Modules](module.md)
- [Python Functions](function.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)
- [GIL, mutability and object types](types.md)
- [Parallelism](parallelism.md)
- [Debugging](debugging.md)
- [Features Reference](features.md)
- [Memory Management](memory.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)
  - [Async / Await](ecosystem/async-await.md)
- [FAQ & Troubleshooting](faq.md)

---

[Appendix A: Migration Guide](migration.md)
[Appendix B: PyO3 and rust-cpython](rust_cpython.md)
[Appendix C: Trait bounds](trait_bounds.md)
[Appendix D: Python typing hints](python_typing_hints.md)
[CHANGELOG](changelog.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: 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			`- [Python Modules](module.md)`
			`- [Python Functions](function.md)`
			`- [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)`
Add Documentation on build and linker args 2018-11-15 19:35:16 +00:00			`- [Type Conversions](conversions.md)`
Start splitting long guide pages into subchapters 2020-09-01 21:40:41 +00:00			`- [Mapping of Rust types to Python types](conversions/tables.md)]`
			`- [Conversion traits](conversions/traits.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			`- [Python Exceptions](exception.md)`
			`- [Calling Python from Rust](python_from_rust.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)`
auto-initialize: add CHANGELOG and docs 2021-01-02 16:46:44 +00:00			`- [Features Reference](features.md)`
Improve documentation about when we free memory, resolves #311 (#1807) * Improve API docs regarding when we free memory, resolves #311 * Add chapter to guide about when we free memory, resolves #311 * Fix typos in documentation Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com> * Add links from guide to docs.rs * Update guide/src/memory.md Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com> 2021-08-21 08:23:10 +00:00			`- [Memory Management](memory.md)`
Add notes about the c api and stacktraces to the guide 2019-03-04 22:17:48 +00:00			`- [Advanced Topics](advanced.md)`
Test readme and user guide with doc-comment Also rename some files for consistency. 2019-04-14 10:58:12 +00:00			`- [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: organise more chapters into sublevels 2021-01-24 12:27:42 +00:00			`- [Useful Crates](ecosystem.md)`
			`- [Logging](ecosystem/logging.md)`
rebased on #1401 2021-01-27 18:08:25 +00:00			`- [Async / Await](ecosystem/async-await.md)`
Add pyo3::once_cell::GILOnceCell 2020-06-14 15:29:40 +00:00			`- [FAQ & Troubleshooting](faq.md)`
Add introduction to guide 2020-08-30 09:08:58 +00:00
			`---`

Add CHANGELOG to the guide 2020-09-05 13:44:39 +00:00			`[Appendix A: Migration Guide](migration.md)`
			`[Appendix B: PyO3 and rust-cpython](rust_cpython.md)`
Add introduction to guide 2020-08-30 09:08:58 +00:00			`[Appendix C: Trait bounds](trait_bounds.md)`
#1959 - Add Python Typing Hints to the Guide 2021-11-06 14:24:39 +00:00			`[Appendix D: Python typing hints](python_typing_hints.md)`
Add CHANGELOG to the guide 2020-09-05 13:44:39 +00:00			`[CHANGELOG](changelog.md)`