Make sphinx not generate bogus undocumented return type in autoclass

[ktbarrett]

This should remove the Return type: statement from the description of Join. Apparently Sphinx thinks class definitions have return types that aren't the class type and it's losing its mind attempting to deduce it so we just turn that logic off and do it manually.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.63%. Comparing base (2bfb730) to head (b2d97a8).
Report is 199 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3974      +/-   ##
==========================================
+ Coverage   72.19%   72.63%   +0.43%     
==========================================
  Files          50       50              
  Lines        8028     8025       -3     
  Branches     2223     2211      -12     
==========================================
+ Hits         5796     5829      +33     
+ Misses       1730     1682      -48     
- Partials      502      514      +12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[marlonjames]

Return type: goes from 77 hits to 16 on the library reference docs page.
In general I like the auto-generated return type info, so maybe as suggested in the sphinx issue we do whatever to override the Join autoclass directive causing the issue?

[ktbarrett]

@marlonjames From the issue:

I'd say it's a bug but I don't really have time (nor the mood) to fix this one.

It seems the return type is included when the return is documented in this mode. When we enable docstring checking in ruff, one of the checks includes enforcing the use of Args, Returns, etc. So we can compensate manually by adding documentation for Returns (which we need to do anyways) and won't have to worry about missing any since they are checked.

[ktbarrett]

Seems like there's no feature for turning off the return type deduction either.

[marlonjames]

Looking at the docs again, if we include
:rtype: type
in the docstring we should be able to add back manually the ones we want.
Too bad we can't disable it just for classes where it fails.