python - software - ¿Cómo puedo generar un valor de configuración en un archivo.rst de Sphinx?

sphinx software

Question

Tengo lo siguiente en conf.py :

def setup(app):
    app.add_config_value(''base_url'',''http://localhost:2000'', True)

¿Cómo consigo esto en mis archivos .rst? Yo escribí esto:

:base_url:/my_app/api/application/

Pero solo imprime :base_url: lugar de la URL real.

¿Cómo obtengo el valor de configuración real para ser emitido?

Answer 1

Ah hah

Eche un vistazo al módulo sphinx.ext.extlinks en http://sphinx.pocoo.org/ext/extlinks.html

Así que tengo un código en mi conf.py que hace esto:

extlinks = {''api_url'' : (settings.BASE_URL + ''%s'', settings.BASE_URL)}

Y en mi archivo .rst, tengo esto:

:api_url:`/myapp/api/application/`

que produce el enlace bien formateado como tal:

http://localhost:8000/myapp/api/application/

Answer 2

Para la sustitución de enlaces, los enlaces externos están bien, para incluir valores de configuración arbitrarios, como se rst_epilog en su pregunta, puede usar rst_epilog para las sustituciones (o rst_prolog para el texto, que debe agregarse a sus archivos .rst):

En tu conf.py:

my_config_value = 42
rst_epilog = ''.. |my_conf_val| replace:: %d'' % my_config_value

En su primera fuente:

Mi valor de configuración es | my_conf_val |!

En su salida:

¡Mi valor de configuración es 42!