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

Add nx-cugraph Docs Pages #4669

Merged
merged 18 commits into from
Oct 3, 2024
Merged

Add nx-cugraph Docs Pages #4669

merged 18 commits into from
Oct 3, 2024

Conversation

nv-rliu
Copy link
Contributor

@nv-rliu nv-rliu commented Sep 25, 2024

Closes https://github.com/rapidsai/graph_dl/issues/606 and [another issue]

Proposed Changes

In preparation for GA release, this PR adds a landing page for nx-cugraph in the cugraph API documentation site. The new pages can be viewed by clicking nx-cugraph in the navigation bar at the top of the page.

New pages

nx-cugraph
└─ How it works
└─ Supported Algorithms
└─ Getting Started
└─ Benchmarks
└─ FAQ

Notes for Reviewers

  • In order to build and test these docs, I modified the build.sh file to use sphinx-autobuild.
122
123     cd ${REPODIR}/docs/cugraph-docs
124     #make html
125     sphinx-autobuild source build/html
126 fi
127
  • For now, I believe the best way to view these changes is to clone the PR branch, then run build.sh in order to host the webserver locally..

@nv-rliu nv-rliu requested a review from a team as a code owner September 25, 2024 09:00
@nv-rliu nv-rliu added doc Documentation improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Sep 25, 2024
Copy link
Contributor

@acostadon acostadon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found some small things but looks good. Still reviewing.

docs/cugraph/source/nx_cugraph/benchmarks.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/faqs.md Outdated Show resolved Hide resolved
@nv-rliu nv-rliu removed the improvement Improvement / enhancement to an existing function label Sep 25, 2024
Copy link
Contributor

@acostadon acostadon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

Copy link
Contributor

@rlratzel rlratzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Ralph. This is a great start. I have a few requests below.

docs/cugraph/source/nx_cugraph/faqs.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/how-it-works.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/how-it-works.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/how-it-works.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/how-it-works.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/nx_cugraph.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/nx_cugraph.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/nx_cugraph.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/suppoal.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/suppoal.md Outdated Show resolved Hide resolved
@nv-rliu nv-rliu requested a review from rlratzel September 30, 2024 15:40
@rlratzel rlratzel requested a review from eriknw September 30, 2024 16:53
@BradReesWork BradReesWork added this to the 24.10 milestone Sep 30, 2024
Copy link
Contributor

@eriknw eriknw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a huge improvement, thank you!

I left a few questions and suggestions, and I have a few questions below.

Should we update the "url" in the get_info function? This controls the link to nx-cugraph from the NetworkX docs

"url": f"https://github.com/rapidsai/cugraph/tree/branch-{_version_major:0>2}.{_version_minor:0>2}/python/nx-cugraph",

Is the algorithm list in supported-algorithms.rst automated? Is it complete? Should we (eventually) try to automate it in a similar way that we update the README using scripts/update_readme.py? Or, can we add a test to ensure it's complete?

Can we link to the official NetworkX docs for backends again in how-it-works.md? I know we already link to NetworkX in index.rst.

docs/cugraph/source/nx_cugraph/benchmarks.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/benchmarks.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/faqs.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/how-it-works.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/how-it-works.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/how-it-works.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/index.rst Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/installation.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/supported-algorithms.rst Outdated Show resolved Hide resolved
@rlratzel
Copy link
Contributor

rlratzel commented Oct 1, 2024

Should we update the "url" in the get_info function? This controls the link to nx-cugraph from the NetworkX docs

"url": f"https://github.com/rapidsai/cugraph/tree/branch-{_version_major:0>2}.{_version_minor:0>2}/python/nx-cugraph",

Yes, I was just going to open a PR to update that. We'll have our proper landing in place by next week and (I think) a temporary redirect in place even sooner, so lets update it to: https://rapids.ai/nx-cugraph (this is the nx-cugraph equivalent of the cudf-pandas landing page)

@nv-rliu nv-rliu requested a review from a team as a code owner October 1, 2024 22:45
@github-actions github-actions bot added the python label Oct 1, 2024
Copy link
Contributor

@eriknw eriknw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is nxcg-execution-diagram.jpg created? Is it from code, and, if so, is this code available somewhere?

docs/cugraph/source/nx_cugraph/how-it-works.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/how-it-works.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/index.rst Show resolved Hide resolved
@nv-rliu
Copy link
Contributor Author

nv-rliu commented Oct 2, 2024

How is nxcg-execution-diagram.jpg created? Is it from code, and, if so, is this code available somewhere?

@eriknw it is not code. It was created by Rick for the SciPy talk and it was borrowed from the presentation.

@BradReesWork
Copy link
Member

/merge

@AyodeAwe AyodeAwe merged commit a936327 into rapidsai:branch-24.10 Oct 3, 2024
130 of 131 checks passed
@nv-rliu nv-rliu deleted the nxcg-docs branch October 3, 2024 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants