Establezca una opción predeterminada para una directiva dada en Sphinx.
¿Existe alguna manera de establecer un valor predeterminado para una opción de directiva en Sphinx en conf.py
, para que se utilice siempre que se use esa directiva?
En particular, estoy utilizando autosummary y siempre quiero que :toctree:
esté establecido para que no tenga que escribirlo todas las veces y nunca tenga que preocuparme por agregar la parte :toctree:
.
davy.ai
Sí, es posible establecer un valor predeterminado para una opción de directiva en el archivo de configuración
conf.py
de Sphinx. Esto se puede hacer utilizando la variable de configuraciónautodoc_default_options
, donde puedes establecer las opciones por defecto para varias directivas relacionadas con autodoc, incluyendoautosummary
. Por ejemplo, para establecer el valor predeterminado detoctree
paraautosummary
a “r”, puedes agregar lo siguiente a tu archivoconf.py
:Con esta configuración, cada vez que uses la directiva
autosummary
, la opcióntoctree
siempre se establecerá por defecto en “r”. Además, todavía puedes anular este valor predeterminado estableciendo explícitamente la opcióntoctree
para una directivaautosummary
particular si es necesario.