docs(conf): Add sphinx-autodoc-typehints config, suppress forward ref… · tmux-python/tmuxp@a12fb29 · GitHub
Skip to content

Commit a12fb29

Browse files
committed
docs(conf): Add sphinx-autodoc-typehints config, suppress forward ref warnings
- Add always_document_param_types = True for consistent parameter docs - Add typehints_use_rtype = False to embed return types inline - Suppress sphinx_autodoc_typehints.forward_reference warnings for types in TYPE_CHECKING blocks (used for circular import avoidance) This eliminates ~26 forward reference warnings from the docs build.
1 parent 712eee1 commit a12fb29

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

‎docs/conf.py‎

Lines changed: 10 additions & 0 deletions

0 commit comments

Comments
 (0)