diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md index ae125119..5d00312d 100644 --- a/guide/src/SUMMARY.md +++ b/guide/src/SUMMARY.md @@ -19,7 +19,9 @@ - [Features Reference](features.md) - [Advanced Topics](advanced.md) - [Building and Distribution](building_and_distribution.md) -- [PyPy support](pypy.md) + - [PyPy support](building_and_distribution/pypy.md) +- [Useful Crates](ecosystem.md) + - [Logging](ecosystem/logging.md) - [FAQ & Troubleshooting](faq.md) --- @@ -27,5 +29,4 @@ [Appendix A: Migration Guide](migration.md) [Appendix B: PyO3 and rust-cpython](rust_cpython.md) [Appendix C: Trait bounds](trait_bounds.md) -[Appendix D: Logging](logging.md) [CHANGELOG](changelog.md) diff --git a/guide/src/pypy.md b/guide/src/building_and_distribution/pypy.md similarity index 100% rename from guide/src/pypy.md rename to guide/src/building_and_distribution/pypy.md diff --git a/guide/src/ecosystem.md b/guide/src/ecosystem.md new file mode 100644 index 00000000..0937a048 --- /dev/null +++ b/guide/src/ecosystem.md @@ -0,0 +1,5 @@ +# The PyO3 Ecosystem + +This portion of the guide is dedicated to crates which are external to the main PyO3 project and provide additional functionality you might find useful. + +Because these projects evolve independently of the PyO3 repository the content of these articles may fall out of date over time; please file issues on the PyO3 Github to alert maintainers when this is the case. diff --git a/guide/src/logging.md b/guide/src/ecosystem/logging.md similarity index 100% rename from guide/src/logging.md rename to guide/src/ecosystem/logging.md diff --git a/src/lib.rs b/src/lib.rs index 462d3249..33b2402f 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -379,22 +379,34 @@ pub mod doc_test { "../guide/src/building_and_distribution.md", guide_building_and_distribution_md ); + doctest!( + "../guide/src/building_and_distribution/pypy.md", + guide_building_and_distribution_pypy_md + ); doctest!("../guide/src/class.md", guide_class_md); + doctest!("../guide/src/class/protocols.md", guide_class_protocols_md); doctest!("../guide/src/conversions.md", guide_conversions_md); + doctest!( + "../guide/src/conversions/tables.md", + guide_conversions_tables_md + ); + doctest!( + "../guide/src/conversions/traits.md", + guide_conversions_traits_md + ); doctest!("../guide/src/debugging.md", guide_debugging_md); doctest!("../guide/src/exception.md", guide_exception_md); doctest!("../guide/src/function.md", guide_function_md); doctest!("../guide/src/migration.md", guide_migration_md); doctest!("../guide/src/module.md", guide_module_md); + doctest!("../guide/src/parallelism.md", guide_parallelism_md); doctest!( "../guide/src/python_from_rust.md", guide_python_from_rust_md ); - doctest!("../guide/src/parallelism.md", guide_parallelism_md); - doctest!("../guide/src/pypy.md", guide_pypy_md); doctest!("../guide/src/rust_cpython.md", guide_rust_cpython_md); - doctest!("../guide/src/types.md", guide_types_md); doctest!("../guide/src/trait_bounds.md", guide_trait_bounds_md); + doctest!("../guide/src/types.md", guide_types_md); } // interim helper until #[cfg(panic = ...)] is stable