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

nx-cugraph API docs #101

Open
jameslamb opened this issue Feb 21, 2025 · 3 comments
Open

nx-cugraph API docs #101

jameslamb opened this issue Feb 21, 2025 · 3 comments

Comments

@jameslamb
Copy link
Member

Description

Should there be API docs for nx-cugraph, e.g. showing the available classes, functions, etc. and their arguments and attributes?

I don't see any getting built:

Notes

The nx-cugraph repo does not have its own docs builds publishing API docs: rapidsai/nx-cugraph#93

Opening this to ask if this was missed in the recent migrations where projects moved around to different repos.

cc @acostadon @eriknw @nv-rliu

@eriknw
Copy link
Contributor

eriknw commented Feb 21, 2025

I don't believe anything was missed from the recent migrations. To date, we use networkx docs as our API docs (for example, see jaccard_coefficient).

@acostadon
Copy link
Contributor

I think I remember nwhat erikw said being before. It is only called through NetworkX

@jameslamb
Copy link
Member Author

Oh interesting!

Ok if this is intentional, then you can close this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants