2011-05-25 12 views
8

Estoy tratando de usar Sphinx para documentar un proyecto, pero no puedo entender cómo usar intersphinx. Yo uso esta línea:¿Cómo puedo poner un enlace intersphinx a un método arbitrario en la documentación de la biblioteca estándar?

:py:meth:`math.sin` 

para añadir el enlace, pero en la salida, se muestra en negrita, no como un enlace. A pesar de que la línea no funciona, tanto en lo siguiente hacer:

:py:meth:`dict.items` 
:py:class:`zipfile.ZipFile` 

Mi valor intersphinx_mapping en el archivo conf.py es:

intersphinx_mapping = {'python':('http://docs.python.org/2.7', None)} 

Respuesta

4

¿Usted ha leído la documentación de intersphinx?

Editar

tengo que trabajar utilizando la siguiente:

*** 
TRY 
*** 

My try 
====== 

sin 
:py:func:`math.cos` 

pop 
:py:meth:`dict.pop` 

dict 
:py:meth:`dict.items` 

zipfile 
:py:class:`zipfile.ZipFile` 

Lea sobre las construcciones aquí crossreference

+1

He leído la documentación de Intersphinx, pero no veo nada que me ayude ... He editado la publicación con más detalles. –

+0

Sí, seguí todas las instrucciones en esa página. –

+0

realmente no me funciona, encontré esta interesante publicación que estoy leyendo ahora http://comments.gmane.org/gmane.comp.python.sphinx.devel/4283 –

8

El :py:meth: debe ser :py:func:. Básicamente, se puede usar cualquier domain válido.

+0

Creo que lo solucionamos al mismo tiempo utilizando el mismo enlace, ejercicio interesante ;-) –

+1

Sí, lo he notado, he notado que algunas partes de la documentación de Sphinx son bastante malas. –

+0

': py: func:' funciona, pero debe tenerse en cuenta que [intersphinx] (http://sphinx-doc.org/latest/ext/intersphinx.html) debe configurarse primero. –

Cuestiones relacionadas