rapidsai / rapidsai/cugraph-docs
nx-cugraph API docs
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 5
- Forks
- 23
- Avg merge
- 13h 44m
- Merged PRs (30d)
- 9
Description
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:
- https://github.com/rapidsai/cugraph-docs/blob/branch-25.04/docs/cugraph-docs/source/api_docs/index.rst?plain=1
- https://docs.rapids.ai/api/cugraph/nightly/api_docs/
- https://docs.rapids.ai/api/cugraph/nightly/nx_cugraph/
Notes
The nx-cugraph repo does not have its own docs builds publishing API docs: https://github.com/rapidsai/nx-cugraph/pull/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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the API documentation index at docs/cugraph-docs/source/api_docs/index.rst with the published cuGraph API and nx_cugraph pages. Review nx-cugraph pull request 93 and the recent repository migration context to determine whether API docs are expected here. Done means agreeing on ownership and documenting the available nx-cugraph classes, functions, arguments, and attributes if they belong in this build.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100