2013-02-03 32 views
7

Tôi đang viết tài liệu cho thư viện python của tôi Sử dụng nhân sư, tôi cũng đã thêm tài liệu nhân sư khác với intersphinx. Và nó hoạt động khá tốt, nhưng một vài chức năng của tôi được đặt tên giống như trong tài liệu tham chiếu, dẫn đến việc che giấu tên của chúng để tham chiếu :func:....Giải quyết xung đột tên trong các tham chiếu trong Sphinx với intersphinx

Có cách nào tôi có thể tham chiếu chức năng bị che bóng do_some() trong tài liệu khác không? (:func:`do_some` tạo ra một liên kết đến chức năng của tôi do_some())

Trả lời

6

Theo docs bạn có thể sử dụng định danh từ của bạn intersphinx_mapping như một tiền tố đến mục tiêu. Ví dụ:

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

Tôi nghĩ điều này cũng phù hợp với công việc với chức năng.

+0

Cảm ơn, điều đó đã giúp tôi sử dụng ': func: \' python: do_some \ '' và nó đã hoạt động – Suor

Các vấn đề liên quan