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

[DOC]: use intersphinx_mapping to link to NetworkX docs #4285

Closed
2 tasks done
raybellwaves opened this issue Mar 27, 2024 · 0 comments · Fixed by #4323
Closed
2 tasks done

[DOC]: use intersphinx_mapping to link to NetworkX docs #4285

raybellwaves opened this issue Mar 27, 2024 · 0 comments · Fixed by #4323
Assignees
@acostadon
Labels
doc Documentation

Comments

@raybellwaves
Copy link
Contributor

raybellwaves commented Mar 27, 2024 •
edited
Loading

How would you describe the priority of this documentation request

Low (would be nice)

Describe the future/missing documentation

I see cugraph doesn't use any intersphinx mapping in it's docs.

What is intersphinx mapping? It's a way to easily create a hyperlink to the API of the other docs.

For example in your docstring you could have """See :func:networkx.convert_matrix.from_pandas_edgelist""" and it should render with a link to https://networkx.org/documentation/stable/reference/generated/networkx.convert_matrix.from_pandas_edgelist.html

One example where I could find it in rapids was https://docs.rapids.ai/api/dask-cudf/stable/#dataframe-creation-from-on-disk-formats which has a link to https://docs.dask.org/en/stable/generated/dask.dataframe.read_parquet.html#dask.dataframe.read_parquet using code :func:dask.dataframe.read_parquet

This could be used in cuGraph to link to the networkx API where appropriate. It could also help with things like making notes on compatibility e.g. in cugraph from_pandas_edgelist has arg destination where as networkx from_pandas_edgelist has arg target.

Some of this can be copied from networkx docs (https://github.com/networkx/networkx/blob/main/doc/conf.py#L231)

Where have you looked?

https://github.com/rapidsai/cugraph/blob/branch-24.04/docs/cugraph/source/conf.py#L194

Code of Conduct

  • I agree to follow cuGraph's Code of Conduct
  • I have searched the open documentation issues and have found no duplicates for this bug report
@raybellwaves raybellwaves added ? - Needs Triage Need team to review and classify doc Documentation labels Mar 27, 2024
@raybellwaves raybellwaves mentioned this issue Apr 9, 2024
Merged
@BradReesWork BradReesWork removed the ? - Needs Triage Need team to review and classify label Apr 15, 2024
rapids-bot bot pushed a commit that referenced this issue May 21, 2024
@raybellwaves
test sphinx mapping to networkx (#4323)
6bd08d2 
Closes #4285

I'll report back if it get to render locally. Ran out of mem building the library on my ec2 machine (g5.2xlarge: 32 Gb RAM) but I did just build cudf. I'll try again soon.

~~Also brainstorming here and I probably should upstream this to the rapids CI process. Would be nice to have /ok to test docs which just builds the docs for this PR~~ created nv-gha-runners/nvidia-runners#25

I tried building the docs locally and got

```
WARNING: [autosummary] failed to import cugraph.jaccard_w.
Possible hints:
* AttributeError: module 'cugraph' has no attribute 'jaccard_w'
* ImportError: 
* ModuleNotFoundError: No module named 'cugraph.jaccard_w'
WARNING: [autosummary] failed to import cugraph.overlap_w.
Possible hints:
* ModuleNotFoundError: No module named 'cugraph.overlap_w'
* ImportError: 
* AttributeError: module 'cugraph' has no attribute 'overlap_w'
WARNING: [autosummary] failed to import cugraph.sorensen_w.
Possible hints:
* ModuleNotFoundError: No module named 'cugraph.sorensen_w'
* ImportError: 
* AttributeError: module 'cugraph' has no attribute 'sorensen_w'
```

Think this comes from https://github.com/rapidsai/cugraph/blob/abe69c0419b67b567d3c8fce91ee1a062d53e385/docs/cugraph/source/api_docs/cugraph/link_prediction.rst#L14

but I may have messed up my build

Authors:
  - Ray Bell (https://github.com/raybellwaves)
  - Rick Ratzel (https://github.com/rlratzel)

Approvers:
  - Rick Ratzel (https://github.com/rlratzel)

URL: #4323
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@acostadon acostadon

Labels
doc Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

test sphinx mapping to networkx raybellwaves/cugraph
3 participants
@raybellwaves @BradReesWork @acostadon