Skip to content

Add autodocs for all libraries, take 2 [only docs]#2972

Merged
maleadt merged 7 commits into
JuliaGPU:masterfrom
gdalle:gd/libdocs_bis
Jan 6, 2026
Merged

Add autodocs for all libraries, take 2 [only docs]#2972
maleadt merged 7 commits into
JuliaGPU:masterfrom
gdalle:gd/libdocs_bis

Conversation

@gdalle

@gdalle gdalle commented Nov 14, 2025

Copy link
Copy Markdown
Contributor

Replaces #2967

@maleadt

maleadt commented Nov 14, 2025

Copy link
Copy Markdown
Member

Superficially LGTM, but we sadly don't have preview functionality set-up. I take it you checked locally this looks OK?

@gdalle

gdalle commented Nov 14, 2025

Copy link
Copy Markdown
Contributor Author

I didn't try to check this locally for lack of an NVIDIA GPU, should I?

@gdalle

gdalle commented Nov 14, 2025

Copy link
Copy Markdown
Contributor Author

My intuition was that doctests would fail anyway if I tried to build locally

@gdalle

gdalle commented Nov 19, 2025

Copy link
Copy Markdown
Contributor Author

Can anyone try building these docs locally?

@kshyatt

kshyatt commented Nov 19, 2025

Copy link
Copy Markdown
Member

Trying now

@kshyatt

kshyatt commented Nov 19, 2025

Copy link
Copy Markdown
Member

Doc build failed, I'll upload the log later

@gdalle

gdalle commented Nov 19, 2025

Copy link
Copy Markdown
Contributor Author

Why did the ci get a green check 🤔?

@gdalle

gdalle commented Dec 2, 2025

Copy link
Copy Markdown
Contributor Author

So apparently the docs build fails locally (according to @kshyatt) with this log
doclog.txt

I added the missing Adapt dep but the others seem to be failing doctests that I cannot fix locally for lack of an NVIDIA card. @maleadt who do you think could help out to get this merged?

@gdalle

gdalle commented Dec 8, 2025

Copy link
Copy Markdown
Contributor Author

The other doctests worked this time on Buildkite, so maybe we're good to go!

@kshyatt kshyatt requested a review from maleadt December 8, 2025 09:36
@maleadt maleadt self-assigned this Dec 8, 2025
@maleadt maleadt added the documentation Improvements or additions to documentation label Dec 8, 2025
@maleadt

maleadt commented Dec 8, 2025

Copy link
Copy Markdown
Member

Sections are empty:

image

@gdalle

gdalle commented Dec 8, 2025

Copy link
Copy Markdown
Contributor Author

That probably means there are no docstrings in that library to begin with? I only set up autodocs so that if those docstrings exist, they will be displayed

@maleadt

maleadt commented Jan 6, 2026

Copy link
Copy Markdown
Member

I'm not a fan of those empty sections, is why I pointed them out; it only clutters the documentation site. But I also don't have the time to work on this, so let's merge this as an incremental improvement.

@maleadt maleadt closed this Jan 6, 2026
@maleadt maleadt reopened this Jan 6, 2026
@maleadt maleadt merged commit 44cde93 into JuliaGPU:master Jan 6, 2026
4 of 5 checks passed
@gdalle gdalle deleted the gd/libdocs_bis branch January 6, 2026 10:07
@gdalle

gdalle commented Jan 6, 2026

Copy link
Copy Markdown
Contributor Author

Let's hope it entices people to write the docstrings :) thanks for merging

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.

3 participants