Posso suprimir a expansão variável na documentação do Sphinx?
No meu código eu tenho
X_DEFAULT = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'referred', 'to', 'in', 'the', 'documentation']
e depois
def some_function(..., x=X_DEFAULT, ...):
para que, na documentação do Sphinx, use (por exemplo, usando.. autofunction::
etc.) recebo todo o valor longo e pesado deX_DEFAULT
expandido na assinatura desome_function
:
some_function(..., x = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'feio', 'para', 'ver' , 'over', 'e', 'over', 'again', 'every', 'time', 'it', 'is', 'referidos', 'para', 'em', 'o', ' documentação '], ...)
Existe uma maneira de suprimir essa substituição na documentação gerada, idealmente com um link para a definição deX_DEFAULT
:
some_function(..., x =X_DEFAULT, ...)
Estou ciente de que posso substituir manualmente a assinatura de cada função e método que listo explicitamente como argumentos para as diretivas de documentação do Sphinx, mas esse não é o meu objetivo aqui. Eu também estou ciente de que eu poderia usarautodoc_docstring_signature
e a primeira linha da doutrina, mas isso produziria doutrinas incorretas, realmente destinadas a casos em que a introspecção falha (como C). Eu suspeito que há algo que eu poderia fazer emautodoc-process-signature
isso pode ser adequado (mas não perfeito), embora não tenha certeza de como proceder.