Sphinx: generar referencias automáticas para tickets y conjuntos de cambios Trac

Question

¿Hay alguna forma de vincular automáticamente texto como #112 o r1023 con los tickets/conjuntos de cambios correspondientes en Trac?

Por ejemplo:

#112 -> http://mytracsite/tickets/112 
r1023 -> http://mytracsite/changeset/1023 

Ver TracLinks para más ejemplos.

Answer 1

si se pone esto en su config.py

trac_url = 'http://mytratsite/' 

from docutils import nodes, utils 
from docutils.parsers.rst import roles 
import urllib 

def trac_role(role, rawtext, text, lineno, inliner, options={}, content=[]): 
    ref = trac_url + '/intertrac/' + urllib.quote(text, safe='') 
    node = nodes.reference(rawtext, utils.unescape(text), refuri=ref, **options) 
    return [node],[] 

roles.register_canonical_role('trac', trac_role) 

continuación, puede utilizar :trac:`#123` y :trac:`r1023` en sus documentos.

Esta es probablemente la forma más fácil de hacer enlaces rápidos a un sitio de trac. Funciona automáticamente para todo tipo de TracLinks porque usa el mecanismo intertrac para los enlaces.

Answer 2

Sphinx 1.0 ahora es compatible con external links con la extensión extlinks. El uso de un nombre de función configurable (por ejemplo, 'problema') se puede escribir como sus enlaces:

:issue:`123` 

y se convertirá a http://mytracsite/123.