-
Notifications
You must be signed in to change notification settings - Fork 100
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.
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
Update README/docs to use pyproject.toml
+ separate setup.py
docs
#356
Conversation
2ee9adf
to
b16c90f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much again, this is brilliant!
I was going to suggest we pause on merging this one until setuptools' pyproject.toml
support is out of beta, and then I saw you already did that last week ❤️
Just a few tiny suggestions to the prose...
Co-authored-by: David Hewitt <[email protected]>
to distribute. You can see examples for these files in the | ||
[`examples/hello-world`](https://github.com/PyO3/setuptools-rust/tree/main/examples/hello-world) | ||
directory in the [github repository](https://github.com/PyO3/setuptools-rust). | ||
The [PyO3 docs](https://pyo3.rs) have detailed information on how to write Python |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we also mention rust-cpython
here? Although I don't think there is any example using rust-cpython
(or is there?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's fine as-is; rust-cpython
is relatively unmaintained recently and as you say we also lack any example of it here. I think if someone wanted to contribute an example and extend documentation to discuss rust-cpython
I would accept it, just no need to block this PR on it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks once again, setuptools-rust
has enjoyed a great polishing recently by your efforts ❤️
This PR attempts to target a few review comment in #348, specifically:
Remarks:
README.md
I cannot use MyST-specific blocks (likeliteralinclude
) or sphinx directives (like{pep}
), because GitHub does not support it. So I just added a simplified version of thehello-world
example, and linked where the users could obtain the.rs
and.py
files.hello-world-setuppy
file to make it simpler and suitable for the separated docs forsetup.py
. The other examples already cover binaries, so I though that a shared library as Python module would be more relevant.docs
session tonox
to facilitate checking how the docs would be rendered.