" > target/banner.html
+ cargo +nightly pyo3_doc_internal
+ cp -r target/doc gh-pages-build/internal
+ env:
+ RUSTDOCFLAGS: "--cfg docsrs --Z unstable-options --document-hidden-items --html-before-content target/banner.html"
+
+ - name: Deploy internal docs
+ if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'release' }}
+ uses: peaceiris/actions-gh-pages@v3
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: ./gh-pages-build/internal
+ destination_dir: internal
+ full_commit_message: "Upload internal documentation"
+
+ - name: Clear the extra artefacts created earlier
+ run: rm -rf target
+
# This builds the book in gh-pages-build. See https://github.com/rust-lang-nursery/mdBook/issues/698
- name: Build the guide
run: mdbook build -d ../gh-pages-build guide
@@ -44,11 +67,11 @@ jobs:
# This adds the docs to gh-pages-build/doc
- name: Build the doc
run: |
- cargo +nightly rustdoc --lib --no-default-features --features="macros num-bigint num-complex hashbrown indexmap serde multiple-pymethods eyre anyhow" -- --cfg docsrs
+ cargo +nightly pyo3_doc_scrape
cp -r target/doc gh-pages-build/doc
echo "" > gh-pages-build/doc/index.html
- - name: Deploy
+ - name: Deploy docs and the guide
if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'release' }}
uses: peaceiris/actions-gh-pages@v3
with:
@@ -56,7 +79,6 @@ jobs:
publish_dir: ./gh-pages-build/
destination_dir: ${{ steps.prepare_tag.outputs.tag_name }}
full_commit_message: "Upload documentation for ${{ steps.prepare_tag.outputs.tag_name }}"
-
release:
needs: build
runs-on: ubuntu-latest
diff --git a/Cargo.toml b/Cargo.toml
index b81f1ae6..7f724dd8 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -79,6 +79,10 @@ auto-initialize = []
# Optimizes PyObject to Vec conversion and so on.
nightly = []
+# Activates all additional features
+# This is mostly intended for testing purposes - activating *all* of these isn't particularly useful.
+full = ["macros", "macros", "multiple-pymethods", "num-bigint", "num-complex", "hashbrown", "serde", "indexmap", "eyre", "anyhow"]
+
[[bench]]
name = "bench_call"
harness = false
diff --git a/Contributing.md b/Contributing.md
index 5c998d64..118ba3c9 100644
--- a/Contributing.md
+++ b/Contributing.md
@@ -9,7 +9,9 @@ If you want to become familiar with the codebase, see
## Getting started contributing
-Please join in with any part of PyO3 which interests you. We use GitHub issues to record all bugs and ideas. Feel free to request an issue to be assigned to you if you want to work on it.
+Please join in with any part of PyO3 which interests you. We use GitHub issues to record all bugs and ideas. Feel free to request an issue to be assigned to you if you want to work on it.
+
+You can browse the API of the non-public parts of PyO3 [here](https://pyo3.rs/internal/pyo3/index.html).
The following sections also contain specific ideas on where to start contributing to PyO3.
@@ -34,7 +36,8 @@ There are some specific areas of focus where help is currently needed for the do
- Issues requesting documentation improvements are tracked with the [documentation](https://github.com/PyO3/pyo3/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation) label.
- Not all APIs had docs or examples when they were made. The goal is to have documentation on all PyO3 APIs ([#306](https://github.com/PyO3/pyo3/issues/306)). If you see an API lacking a doc, please write one and open a PR!
-You can build the docs (including all features) with `cargo +nightly rustdoc --features="$(make list_all_additive_features)" --open -- --cfg docsrs`.
+You can build the docs (including all features) with
+```cargo +nightly pyo3_doc_scrape```
#### Doctests
@@ -47,7 +50,7 @@ https://doc.rust-lang.org/rustdoc/documentation-tests.html for a guide on doctes
You can preview the user guide by building it locally with `mdbook`.
First, [install `mdbook`](https://rust-lang.github.io/mdBook/cli/index.html). Then, run
-`mdbook build -d ../gh-pages-build guide --open`.
+```mdbook build -d ../gh-pages-build guide --open```
### Help design the next PyO3
@@ -71,7 +74,7 @@ Formatting, linting and tests are checked for all Rust and Python code. In addit
Tests run with all supported Python versions with the latest stable Rust compiler, as well as for Python 3.9 with the minimum supported Rust version.
-If you are adding a new feature, you should add it to the `ALL_ADDITIVE_FEATURES` declaration in the `Makefile` so that it is tested in CI.
+If you are adding a new feature, you should add it to the `full` feature in our *Cargo.toml** so that it is tested in CI.
## Python and Rust version support policy
diff --git a/pyo3-macros-backend/src/lib.rs b/pyo3-macros-backend/src/lib.rs
index 69fc24d2..ac8cc30a 100644
--- a/pyo3-macros-backend/src/lib.rs
+++ b/pyo3-macros-backend/src/lib.rs
@@ -1,7 +1,7 @@
// Copyright (c) 2017-present PyO3 Project and Contributors
//! This crate contains the implementation of the proc macro attributes
-#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![recursion_limit = "1024"]
// Listed first so that macros in this module are available in the rest of the crate.
diff --git a/pyo3-macros-backend/src/method.rs b/pyo3-macros-backend/src/method.rs
index dda829be..e7d0a00e 100644
--- a/pyo3-macros-backend/src/method.rs
+++ b/pyo3-macros-backend/src/method.rs
@@ -64,17 +64,17 @@ impl<'a> FnArg<'a> {
#[derive(Clone, PartialEq, Debug, Copy, Eq)]
pub enum MethodTypeAttribute {
- /// #[new]
+ /// `#[new]`
New,
- /// #[classmethod]
+ /// `#[classmethod]`
ClassMethod,
- /// #[classattr]
+ /// `#[classattr]`
ClassAttribute,
- /// #[staticmethod]
+ /// `#[staticmethod]`
StaticMethod,
- /// #[getter]
+ /// `#[getter]`
Getter,
- /// #[setter]
+ /// `#[setter]`
Setter,
}
diff --git a/pyo3-macros/src/lib.rs b/pyo3-macros/src/lib.rs
index a6f6725c..61ee90a4 100644
--- a/pyo3-macros/src/lib.rs
+++ b/pyo3-macros/src/lib.rs
@@ -2,7 +2,7 @@
//! This crate declares only the proc macro attributes, as a crate defining proc macro attributes
//! must not contain any other public items.
-#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
extern crate proc_macro;
use proc_macro::TokenStream;
diff --git a/src/conversions/anyhow.rs b/src/conversions/anyhow.rs
index e9d1e339..463e1265 100644
--- a/src/conversions/anyhow.rs
+++ b/src/conversions/anyhow.rs
@@ -1,6 +1,9 @@
#![cfg(feature = "anyhow")]
-//! A conversion from [anyhow]’s [`Error`][anyhow_error] type to [`PyErr`].
+//! A conversion from
+//! [anyhow](https://docs.rs/anyhow/ "A trait object based error system for easy idiomatic error handling in Rust applications.")’s
+//! [`Error`](https://docs.rs/anyhow/latest/anyhow/struct.Error.html "Anyhows `Error` type, a wrapper around a dynamic error type")
+//! type to [`PyErr`].
//!
//! Use of an error handling library like [anyhow] is common in application code and when you just
//! want error handling to be easy. If you are writing a library or you need more control over your
@@ -101,8 +104,6 @@
//! }
//! ```
//!
-//! [anyhow]: https://docs.rs/anyhow/ "A trait object based error system for easy idiomatic error handling in Rust applications."
-//! [anyhow_error]: https://docs.rs/anyhow/latest/anyhow/struct.Error.html "Anyhows `Error` type, a wrapper around a dynamic error type"
//! [`RuntimeError`]: https://docs.python.org/3/library/exceptions.html#RuntimeError "Built-in Exceptions — Python documentation"
//! [Error handling]: https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html "Recoverable Errors with Result - The Rust Programming Language"
diff --git a/src/conversions/eyre.rs b/src/conversions/eyre.rs
index 4d4014ff..546a7fbc 100644
--- a/src/conversions/eyre.rs
+++ b/src/conversions/eyre.rs
@@ -1,6 +1,8 @@
#![cfg(feature = "eyre")]
-//! A conversion from [eyre]’s [`Report`] type to [`PyErr`].
+//! A conversion from
+//! [eyre](https://docs.rs/eyre/ "A library for easy idiomatic error handling and reporting in Rust applications.")’s
+//! [`Report`] type to [`PyErr`].
//!
//! Use of an error handling library like [eyre] is common in application code and when you just
//! want error handling to be easy. If you are writing a library or you need more control over your
diff --git a/src/internal_tricks.rs b/src/internal_tricks.rs
index 307f1bfc..27add5ca 100644
--- a/src/internal_tricks.rs
+++ b/src/internal_tricks.rs
@@ -4,7 +4,8 @@ use std::marker::PhantomData;
use std::rc::Rc;
/// A marker type that makes the type !Send.
-/// Temporal hack until https://github.com/rust-lang/rust/issues/13231 is resolved.
+///
+/// Temporal hack until is resolved.
pub(crate) type Unsendable = PhantomData>;
pub struct PrivateMarker;