Làm cách nào tôi có thể sử dụng chỉ thị nội tuyến chỉ bằng cách sử dụng vai trò trong python-sphinx?

Question

Trong python-sphinx có only directive, có thể được sử dụng để có điều kiện ảnh hưởng đến tài liệu theo đầu ra của nó. Ví dụ: văn bản chỉ xuất hiện bằng html hoặc latex.

Nó được sử dụng như thế này:

 
.. only:: not latex 

    Here there is some Text, that does not appear in latex output. 

.. only:: html 

    Here there is some Text, that only appears in html output. 

Làm thế nào tôi có thể sử dụng các chỉ thị vai trò trong việc đúng cách để sử dụng inline chỉ hạng nhất, chúng ta hãy nói như thế này:

 
Here there is some Text, that :only-notlatex:`does not appear in latex`
:only-html:`only appears in html`. 

tôi thấy một cái gì đó tương tự cho chỉ thị thô. Điều này cũng có thể cho chỉ thị duy nhất? Tôi đã thử:

 

.. role:: only-html(only) 
    :format: html 

.. role:: only-notlatex(only) 
    :format: not latex 

Nhưng điều này không hiệu quả.

Answer 1

Chỉ thị hoạt động trên các khối văn bản (toàn bộ các đoạn); vai trò dành cho văn bản nội tuyến (trong các đoạn văn).

Bạn đã đề cập raw và thực sự có cả số directive và role với tên đó, để "truyền dữ liệu thô".

Nhưng không có vai trò tích hợp nào tương đương nội tuyến của chỉ thị only. Bạn sẽ phải tạo vai trò tùy chỉnh của riêng mình cho mục đích này. Tôi không thể cung cấp bất kỳ hướng dẫn chi tiết nào, nhưng đây là một bài viết có thể giúp bạn bắt đầu: http://doughellmann.com/2010/05/09/defining-custom-roles-in-sphinx.html.