Docs: Enable autosummary for instrument module

[jenshnielsen]

This currently requires a branch of sphinx to fix documenting inherited attributes. That branch is open as sphinx-doc/sphinx#10691

To install sphinx 5.x we need the master branch of autodocsumm. That does not otherwise carry any fixes

This is done as a branch that carries my changes directly on top of 5.0.x since 5.1.0 broke the build. See sphinx-doc/sphinx#10701

@astafan8 What do you think is it acceptable to build with a patched version of sphinx until that is merged.

This will also enable us to activate autodocsumm for #4371 which will make that way more readable

[codecov]

Codecov Report

Merging #4273 (b1b1ee7) into master (9d27254) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4273   +/-   ##
=======================================
  Coverage   68.36%   68.36%           
=======================================
  Files         276      276           
  Lines       31024    31024           
=======================================
  Hits        21210    21210           
  Misses       9814     9814           

[astafan8]

What do you think is it acceptable to build with a patched version of sphinx until that is merged

to keep things safe, i'd wait. i guess it all can easily take a month, right? the fix in sphinx is one thing, but also installing autodocsumm from master branch does not look super good.

what is the backup plan? we can just revert to a released version of sphinx and autodocsumm and remove the :autosummary: directive, right? if it's indeed that easy, then we can try to this risk, but perhaps pin autodocsumm to a particular commit?

[jenshnielsen]

to keep things safe, i'd wait. i guess it all can easily take a month, right? the fix in sphinx is one thing, but also installing autodocsumm from master branch does not look super good.

I would be happy to install it from a specific commit. The only reason that I did not bother is that its a project that moves fairly slow.

what is the backup plan? we can just revert to a released version of sphinx and autodocsumm and remove the :autosummary: directive, right? if it's indeed that easy, then we can try to this risk, but perhaps pin autodocsumm to a particular commit?

Yes, this can be undone by either removing the autosummary directive from modules that makes use of inherited attributes
or by allowing building the docs with warnings as errors in which case the inherited attributes will simply be missing from the tabels in the docs.

[astafan8]

ok, with the backup plan laid out, let's go :)