2011-05-25 19 views
8

Bir projeyi belgelemek için Sphinx kullanmaya çalışıyorum, ancak intersphinx'i nasıl kullanacağımı anlayamıyorum. Bu satırını kullanın:Standart kütüphane belgelerinde isteğe bağlı bir yönteme nasıl bir intersphinx bağlantısı yerleştirebilirim?

:py:meth:`math.sin` 

bağlantı eklemek için de çıktıda, değil bir bağlantı olarak, kalın görünür. satır çalışmıyor olsa da, iki aşağıdakileri yapın: conf.py dosyasında

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

Benim intersphinx_mapping değerdir:

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

cevap

4

Eğer intersphinx belgelerine okudunuz mu? Burada crossreference

+1

Intersphinx belgelerini okudum, ancak bana yardımcı olan hiçbir şey görmüyorum ... Daha fazla ayrıntı ile yazıyı düzenledim. –

+0

Evet, o sayfadaki tüm talimatları takip ettim. –

+0

benim için de işe yaramıyor, şu anda okuduğum bu ilginç yazıyı şu anda http://comments.gmane.org/gmane.comp.python.sphinx.devel/4283 –

8

:py:meth: yapılara hakkında

*** 
TRY 
*** 

My try 
====== 

sin 
:py:func:`math.cos` 

pop 
:py:meth:`dict.pop` 

dict 
:py:meth:`dict.items` 

zipfile 
:py:class:`zipfile.ZipFile` 

Oku :py:func: olmalıdır:

Düzenleme bu kullanarak çalışmak lazım. Temel olarak,geçerli herhangi bir domain kullanılabilir.

+0

Aynı bağlantıyı kullanarak ilginç bir şekilde çözdüğümüzü düşünelim, ilginç egzersiz ;-) –

+1

Evet, Sfenks belgelerinin bazı bölümlerinin oldukça kötü olduğunu fark ettim. –

+0

': py: func:' çalışır, ancak dikkat edilmelidir ki [intersphinx] (http://sphinx-doc.org/latest/ext/intersphinx.html) ilk olarak ayarlanmalıdır! –