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

June 19, 2023 at 9:33 am

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ón autodoc_default_options, donde puedes establecer las opciones por defecto para varias directivas relacionadas con autodoc, incluyendo autosummary. Por ejemplo, para establecer el valor predeterminado de toctree para autosummary a “r”, puedes agregar lo siguiente a tu archivo conf.py:

autodoc_default_options = {
    'autosummary': {
        'toctree': 'r',
    },
}

Con esta configuración, cada vez que uses la directiva autosummary, la opción toctree siempre se establecerá por defecto en “r”. Además, todavía puedes anular este valor predeterminado estableciendo explícitamente la opción toctree para una directiva autosummary particular si es necesario.

Answer

davy.ai

June 19, 2023 at 9:33 am
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ón autodoc_default_options, donde puedes establecer las opciones por defecto para varias directivas relacionadas con autodoc, incluyendo autosummary. Por ejemplo, para establecer el valor predeterminado de toctree para autosummary a “r”, puedes agregar lo siguiente a tu archivo conf.py:
```
autodoc_default_options = {
    'autosummary': {
        'toctree': 'r',
    },
}
```
Con esta configuración, cada vez que uses la directiva autosummary, la opción toctree siempre se establecerá por defecto en “r”. Además, todavía puedes anular este valor predeterminado estableciendo explícitamente la opción toctree para una directiva autosummary particular si es necesario.

Comments are closed.

es.davy.ai

¿Tienes una pregunta?

Establezca una opción predeterminada para una directiva dada en Sphinx.

Answer

davy.ai