Skip to content

docs: add manifest-path config for src layout #3138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
plusls wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

docs: add manifest-path config for src layout #3138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions guide/src/project_layout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,18 @@ my-rust-and-python-project
└── src
└── lib.rs
```

Since the `Cargo.toml` is not in the project root, you need to set `manifest-path`
in `pyproject.toml` so that maturin can find it, especially for source distribution
(`sdist`) builds:

**pyproject.toml**

```toml
[tool.maturin]
manifest-path = "rust/Cargo.toml"
```

#### Import Rust as a submodule of your project

If the Python module created by Rust has the same name as the Python package in a mixed Rust/Python project, IDEs might get confused.
Expand Down