Nhân sư và argparse - tự động viết kịch bản dòng lệnh?

Question

Tôi đang xây dựng một gói Python và sử dụng Nhân sư để tạo tài liệu. Ngoài mã gói của tôi, tôi cũng bao gồm rất nhiều dòng lệnh Python script, sử dụng argparse. Tôi đã tự hỏi nếu có một cách để có được Sphinx để autodocument các kịch bản? Mục tiêu cuối cùng sẽ là một danh sách các tập lệnh được in đẹp, với các bản in, đối số và tùy chọn liên quan. Và để được rõ ràng, tôi đang tìm một cách có sẵn để làm điều này, không phải là một cách để thực hiện điều này bản thân mình.

Đây không phải là câu hỏi cụ thể như tôi thường hỏi về S.O., nếu có một S.E. thích hợp hơn trang web để đăng câu hỏi này, vui lòng cho tôi biết. Cảm ơn.

Answer 1

Bạn có thể sử dụng sphinxcontrib.programoutput để bao gồm thông báo trợ giúp từ dòng lệnh trong tài liệu của mình.

Điều này không cụ thể cho argparse nhưng có thể được sử dụng để ghi lại mọi thông báo trợ giúp in tập lệnh vào dòng lệnh.

Answer 2

Sử dụng phần mở rộng Sphinx-argparse:

http://sphinx-argparse.readthedocs.org/en/latest/

Answer 3

Bạn có thể sử dụng sphinxcontrib.autoprogram. pip install sphinxcontrib-autoprogram, sau đó đặt

extensions += ['sphinxcontrib.autoprogram'] 

trong conf.py. Để ghi lại lệnh cli.py bằng cách nhập cli với argparse parser đối tượng parser (mà có thể là một biểu hiện Python, như một hàm get_parser()), sử dụng

.. autoprogram:: cli:parser 
    :prog: cli.py