Merge pull request #1122 from davidhewitt/guide-introduction

Add introduction to guide
This commit is contained in:
Yuji Kanagawa 2020-08-30 21:56:03 +09:00 committed by GitHub
commit bd12d89a3e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 4 deletions

View File

@ -1,5 +1,9 @@
# Summary
[Introduction](index.md)
---
- [Python Modules](module.md)
- [Python Functions](function.md)
- [Python Classes](class.md)
@ -13,7 +17,10 @@
- [Building and Distribution](building_and_distribution.md)
- [PyPy support](pypy.md)
- [FAQ & Troubleshooting](faq.md)
- [Appendix A: PyO3 and rust-cpython](rust_cpython.md)
- [Appendix B: Migration Guide](migration.md)
- [Appendix C: Trait bounds](trait_bounds.md)
- [Appendix D: Logging](logging.md)
---
[Appendix A: PyO3 and rust-cpython](rust_cpython.md)
[Appendix B: Migration Guide](migration.md)
[Appendix C: Trait bounds](trait_bounds.md)
[Appendix D: Logging](logging.md)

7
guide/src/index.md Normal file
View File

@ -0,0 +1,7 @@
# The PyO3 Guide
Welcome to the PyO3 user guide! This book is a companion to [PyO3's API docs](https://docs.rs/pyo3). It contains examples and documentation to explain all of PyO3's use cases in detail.
Please choose from the chapters on the left to jump to individual topics, or continue below to start with PyO3's README.
{{#include ../../README.md}}