bao gồm nội dung động trong tài liệu được tạo bởi python-sphinx

Question

Tôi đang sử dụng nhân sư để tạo tài liệu cho dự án của tôi và xây dựng tài liệu như là một phần của quá trình cài đặt của sản phẩm. Tôi muốn tự động bao gồm tên máy chủ trong văn bản và/hoặc khối mã. Tôi đã không thấy bất kỳ giải thích nào trong tài liệu hướng dẫn bất kỳ cơ sở nào để bao gồm đầu ra của lệnh shell hoặc bất kỳ thứ gì ngoài các dòng cụ thể từ một tệp cụ thể. Năng lực này có tồn tại không?

Answer 1

Dưới đây là hai Sphinx extensions có thể làm điều này:

• autorun: thực thi mã Python trong runblock chỉ thị, bắt đầu ra và chèn nó vào tài liệu.
• programoutput: thực hiện các lệnh tùy ý bằng cách sử dụng chỉ thị program-output và chèn đầu ra vào tài liệu.