Tài liệu nhân sư: L ERI: Loại chỉ thị không xác định "chương trình-đầu ra"

Question

Tôi đang cố tạo tài liệu của mình bằng Nhân sư và giờ trên hai máy tôi có cùng vấn đề chính xác: chỉ thị chương trình-đầu ra không hoạt động.

Tôi đã cài đặt Sphinx, sau đó mở rộng programoutput:

$ sudo pip install sphinxcontrib-programoutput 

Quá trình cài đặt diễn ra tốt đẹp, tài liệu biên soạn thật đẹp để thoải mái tìm html, nhưng lệnh ra chỉ không hoạt động.

Tôi tạo ra một trường hợp thử nghiệm siêu đơn giản với một tập tin gọi là test.rst chứa một dòng duy nhất:

.. program-output:: python -V 

Bây giờ khi cố gắng biên dịch này, tôi nhận được kết quả như sau (đường dẫn tắt):

/path/to/test.rst:1: ERROR: Unknown directive type "program-output". 

Thay đổi chương trình đầu ra thành bí danh-đầu ra lệnh của nó không hoạt động (không đáng ngạc nhiên). Tôi thực sự tự hỏi mình đang làm gì sai ở đây. Tôi đã làm theo hướng dẫn cài đặt, đã thử lại lần nữa và một lần nữa, được cài đặt lại với cờ --upgrade, không có gì hoạt động.

Answer 1

Nhờ bmu tôi đã tìm thấy vấn đề, thực sự tôi phải thêm nó vào conf.py.

Bây giờ câu hỏi tiếp theo: "tại sao điều này không có trong tài liệu cài đặt/sử dụng của tiện ích mở rộng này?" Nó không được đề cập trong số http://packages.python.org/sphinxcontrib-programoutput/ là liên kết đầu tiên tôi nhận được khi googling cho tiện ích mở rộng này.

Dù sao câu trả lời hoàn chỉnh, hy vọng nó hữu ích cho những người khác nữa:

Go vào thư mục gốc tài liệu của tài liệu của bạn (ví dụ ~/Projects/project-name/doc), nơi phần còn lại của tài liệu của bạn đang có.

Chỉnh sửa tập tin conf.py

Look cho dòng mà nói extensions = [] (một danh sách trống trong trường hợp của tôi)

Thay đổi này để: extensions = ['sphinxcontrib.programoutput']

Và một cách kỳ diệu nó đột nhiên bắt đầu làm việc.