Skip to content

Conversation

@gdalle
Copy link

@gdalle gdalle commented Nov 12, 2025

Every time I check out cuSPARSE I have to go to the source file to figure out what's inside CuSparseMatrixCSR. This PR is a first step that displays all the docstrings of the libraries and submodules, so that once we actually write them they will appear on the website.
Feel free to reject or modify if you don't think that's a good idea, especially if it reveals/defines "public" API that you don't want to commit to.

@kshyatt kshyatt added the documentation Improvements or additions to documentation label Nov 12, 2025
@kshyatt
Copy link
Member

kshyatt commented Nov 12, 2025

@gdalle you can put [only docs] in the commit message to avoid running the full ci (expensive!!!!) as shown in the README

@gdalle
Copy link
Author

gdalle commented Nov 12, 2025

Oops my bad! I put it in the second commit, hope it is enough

@gdalle
Copy link
Author

gdalle commented Nov 13, 2025

It seems the test suite still ran despite the following commits including "[only docs]". Does this guideline only apply to the very first commit? Should I start a new PR?

@kshyatt
Copy link
Member

kshyatt commented Nov 13, 2025 via email

@gdalle
Copy link
Author

gdalle commented Nov 13, 2025

I tried but it seems to be running anyway? Should I open a new PR?

@kshyatt
Copy link
Member

kshyatt commented Nov 13, 2025

I mean if the docs build succeeds, I'm happy to merge. We can just let it run for now tbh.

@gdalle
Copy link
Author

gdalle commented Nov 13, 2025

I'd love to learn what went wrong for next time though

@gdalle
Copy link
Author

gdalle commented Nov 13, 2025

Sorry I couldn't test the docs build locally, I don't have an NVIDIA GPU

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants