2013-02-03 7 views
7

Piszę dokumenty dla mojej biblioteki Pythona Używając sphinx, dodałem także inną dokumentację sphinx z intersphinx. I działa całkiem nieźle, ale kilka moich funkcji nazywa się tak samo jak w dokumentacji referencyjnej, co prowadzi do zacieniania ich nazw dla odniesień :func:....Rozwiązywanie konfliktów nazw w odnośnikach w Sphinxie z intersphinxem

Czy istnieje sposób, w jaki mogę odwołać się do funkcji ukrytej do_some() w innej dokumentacji? (:func:`do_some` tworzy link do mojej funkcji do_some())

Odpowiedz

6

Według docs można użyć identyfikatora ze swojego intersphinx_mapping jako przedrostek do celu. Przykład:

:ref:`comparison manual <python:comparisons>` 

Myślę, że powinno to działać również w przypadku pracy z funkcjami.

+0

Dzięki, pomogłem, użyłem ': func: \' python: do_some \ '' i to działało – Suor

Powiązane problemy