Closed
Description
From this page on Sphinx configuration options, I think there are some new ones we should try out:
nitpicky = True
to warn about more missing references. Also set thedefault_role
topy:obj
, which will ensure the most common cases work out after all. (main effect: CI will now warn when people use single instead of double-backticks for monospace)needs_sphinx
- dynamically load this fromrequirements/tools.txt
so it stays up-to-date with our pins? We install from pins on readthedocs so this should work fine. Convert the==
to>=
so that checking out an old branch doesn't force a downgrade to build docs.- enable
maximum_signature_line_length
andpython_...
- going to one argument per line will enable us to show type annotations again (changingautodoc_typehints
from none to signature); we'll also want to setautodoc_type_aliases
and perhaps load this dynamically from the source code (matching on_: TypeAlias = _
lines - actually this would be a great feature to upstream!)