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

suggestion to add /ok to build docs #25

Open
raybellwaves opened this issue Apr 9, 2024 · 0 comments
Open

suggestion to add /ok to build docs #25

raybellwaves opened this issue Apr 9, 2024 · 0 comments

Comments

@raybellwaves
Copy link

I apologize if this is the wrong place to make a suggestion. Happy to close this and open it elsewhere.

I've recently made PR's to some of the library where I only updated docs e.g. rapidsai/cugraph#4323

Sometimes if there are only changes to a docstring it may be worth first only testing the docs build e.g. with a command like /ok to build docs which runs just the docs-build / build action (which I think also offers a preview to the docs). I understand the need to finally do a full CI to check that nothing is broken so is the change renders as expected you could like run /ok to test.

rapids-bot bot pushed a commit to rapidsai/cugraph that referenced this issue May 21, 2024
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
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant