Skip to content
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

[DOC] deleted docs in cudf python for building should be removed #14649

Closed
DanialJavady96 opened this issue Dec 18, 2023 · 4 comments
Closed
Labels
doc Documentation

Comments

@DanialJavady96
Copy link
Contributor

https://github.com/rapidsai/cudf/blob/branch-24.02/python/cudf/CONTRIBUTING.md#setting-up-your-build-environment

^ these docs referenced here https://github.com/rapidsai/cudf/tree/branch-24.02/python/cudf in the section Build/Install from Source no longer exist

@DanialJavady96 DanialJavady96 added Needs Triage Need team to review and classify doc Documentation labels Dec 18, 2023
@DanialJavady96
Copy link
Contributor Author

https://github.com/rapidsai/cudf/blob/branch-24.02/CONTRIBUTING.md

Docs here should also be updated for cudf python.

python setup.py build_ext --inplace
python setup.py develop

Are no longer valid, setup.py was removed. I presume you need to run python -m pip install --no-build-isolation --no-deps -e ..

@shwina
Copy link
Contributor

shwina commented Dec 21, 2023

I presume you need to run python -m pip install --no-build-isolation --no-deps -e ..

That sounds right. Any chance you could throw in a PR? :)

@DanialJavady96
Copy link
Contributor Author

I presume you need to run python -m pip install --no-build-isolation --no-deps -e ..

That sounds right. Any chance you could throw in a PR? :)

Sure I don't mind, with that being said #14653 did update the docs alongside the build script to make it more convenient

@bdice
Copy link
Contributor

bdice commented Mar 4, 2024

It looks like there are two topics here:

  1. The links in the README.md work from the README.md in the root, but not in the symlinked python/cudf/README.md. We might be able to use absolute https paths instead of relative links, but I don't think that would be a net benefit for the main README. I'm not sure what the best course of action would be here. I'm leaning towards taking no action here. We still want to symlink the README rather than copy it, and changing to absolute URLs would be a worse outcome for developers and readers alike because the branch names in an absolute URL would go out of date (and would need to be kept in sync with ci/release/update-version.sh. There isn't a great solution that is still maintainable afaict.

  2. There were some references to setup.py but these are now removed.

I think we can close this issue for now. If others have strong feelings about how we should handle (1), please feel free to reopen.

@bdice bdice closed this as completed Mar 4, 2024
@bdice bdice removed the Needs Triage Need team to review and classify label Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

No branches or pull requests

3 participants