2013-05-06 28 views
6

Sử dụng Sphinx, tôi biết bạn có thể hiển thị một mảnh đoạn mã python hoặc đoạn mã ruby ​​bằng cách có một cái gì đó như:python-Sphinx: làm thế nào để hiển thị mã lệnh linux snippets

.. code-block:: ruby. 
    ${your ruby code goes here} 

Làm thế nào tôi có thể hiển thị một mã số đoạn mã của lệnh linux hoặc chỉ một số lệnh giao diện điều khiển không liên quan đến bất kỳ ngôn ngữ nào? Tôi không quan tâm nếu chúng không được đánh dấu đúng cú pháp, tôi chỉ muốn chúng hiển thị trong tài liệu dưới dạng một đoạn mã khác với văn bản bình thường. ví dụ.

ls -lsa . 
make file 

Trả lời

7

Bạn có thể thụt lề văn bản bạn muốn được viết dưới dạng mã và đặt trước bằng dấu hai chấm. Ví dụ:

Some body text explaining what's coming up:: 

    ls -lsa . 
    make file 

Hoặc bạn cũng có thể thoát ra mà không có bất kỳ văn bản nào trước đây, chỉ cần sử dụng dấu hai chấm. Trong trường hợp đầu tiên, một dấu hai chấm được trả lại, trong khi đối với trường hợp này, chỉ cần mã được hiển thị.

:: 
    mkdir test 
    cd !$ 

Sau đó, lệnh sẽ xuất hiện với phông chữ cố định, và tùy thuộc vào kiểu trang bạn đã chọn, được đánh dấu (theo mặc định, được đánh dấu bằng nền màu xanh lục).

Bạn cũng có thể đánh dấu nội tuyến bằng các dấu gạch chéo ngược, ví dụ: `ls -lsa .`.

12

Đối với Linux console lệnh bạn có thể sử dụng bash hoặc sh:

.. code-block:: bash 

    $ ls -lsa . 
    $ make file 

Highlighting sẽ không thể làm việc đúng tất cả các thời gian, nhưng ít nhất bạn cung cấp cho nó một cơ hội.

Bạn cũng có thể thiết lập mặc định nhấn mạnh vào đầu của tập tin nếu bạn sử dụng cách @Bonlenfum với dấu hai chấm kép:

.. highlight:: sh 
10
.. code-block:: console 

là có nghĩa là cho các phiên tương tác. Bash hay sh không làm việc cho tôi.

(từ http://build-me-the-docs-please.readthedocs.org/en/latest/Using_Sphinx/ShowingCodeExamplesInSphinx.html#pygments-lexers)

+0

này được ưa thích hơn 'bash' hoặc 'sh', vì đó là một giao diện điều khiển/thiết bị đầu cuối đang được mô tả, không phải là một kịch bản. Hãy nhận biết mặc dù nó không xử lý tốt dòng dài. –