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.

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

Jump to bottom

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
@jameslamb jameslamb mentioned this issue Feb 21, 2025
Merged
@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.

rapids-bot bot pushed a commit to rapidsai/nx-cugraph that referenced this issue Feb 24, 2025
@jameslamb
remove docs dependencies (#93)
0d9b8f3 
While working on rapidsai/build-planning#155, I realized that this repo no longer has any docs builds.

As far as I can tell, it's just relying on `cugraph-docs` to build and publish its docs:

* https://github.com/rapidsai/cugraph-docs/tree/branch-25.04/docs/cugraph-docs/source/nx_cugraph

If I'm right about that, then this repo doesn't need any `dependencies.yaml` entries for `sphinx` and related dependencies. This proposes removing those, along with other configuration that looks unused (possibly left-over from when this was ported out of https://github.com/rapidsai/cugraph).

## Notes for Reviewers

It looks to me like`nx-cugraph` API docs are missing, maybe unintentionally. Opened rapidsai/cugraph-docs#101 to discuss that.

I think this PR can be merged without a resolution to that conversation... if we want them, we'd likely build those docs with `sphinx.ext.autosummary` as is done for other Python docs there ([example for cugraph](https://github.com/rapidsai/cugraph-docs/blob/debf03cdb5e549b66a6f3b75d95ec836a159ea33/docs/cugraph-docs/source/api_docs/cugraph/tree.rst?plain=1#L17)).

Authors:
  - James Lamb (https://github.com/jameslamb)

Approvers:
  - Jake Awe (https://github.com/AyodeAwe)
  - Erik Welch (https://github.com/eriknw)

URL: #93
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@eriknw @jameslamb @acostadon