docs: Generate documentation for constructor parameters

[edgarrmondragon]

• Document method parameters.
• Add nox task for live-reloading docs.

Current state: https://sdk.meltano.com/en/latest/classes/singer_sdk.Stream.html#singer_sdk.Stream

vs

Preview: https://meltano-sdk--900.org.readthedocs.build/en/900/classes/singer_sdk.Stream.html#singer_sdk.Stream

[codecov]

Codecov Report

Merging #900 (5c3fefc) into main (b6aac25) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #900   +/-   ##
=======================================
  Coverage   80.31%   80.31%           
=======================================
  Files          34       34           
  Lines        3413     3413           
  Branches      679      679           
=======================================
  Hits         2741     2741           
  Misses        499      499           
  Partials      173      173           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[WillDaSilva]

Is it possible to render both the signatures and the detailed parameter / return value content? If so I think that would be ideal. In either case, this looks good to me.

[edgarrmondragon]

Is it possible to render both the signatures and the detailed parameter / return value content? If so I think that would be ideal. In either case, this looks good to me.

@WillDaSilva good idea! I think I've solved that now by explicitly requesting __init__ gets the same treatment as other methods using :special-members: __init__.

[WillDaSilva]

@edgarrmondragon Could you please provide an updated preview link? I'm not sure how you generated it - I don't see any CI actions for it.

[edgarrmondragon]

@edgarrmondragon Could you please provide an updated preview link? I'm not sure how you generated it - I don't see any CI actions for it.

@WillDaSilva It's up-to-date with the changes in this PR. Builds are triggered in readthedocs but it's failing to report back to GitHub in the PR checks.