python-sphinx

22Nhiệt

3Trả lời

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

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ó đượ

13Nhiệt

3Trả lời

Lưu trữ tài liệu tư nhân Sphinx

Tôi hiện đang viết một số tài liệu mở rộng sử dụng Sphinx cho một trang web Django khá phức tạp. Tôi đã làm việc về điều này trong nhà và trước khi tôi rời khỏi sớm, tôi muốn để lại đằng sau tài liệu

47Nhiệt

7Trả lời

Có bất kỳ lựa chọn thay thế thực sự nào cho reStructuredText cho tài liệu Python không?

Tôi đang bắt đầu một dự án Python nguồn mở ngay và tôi đang cố gắng quyết định trước cách viết tài liệu của mình. Câu trả lời rõ ràng sẽ sử dụng reStructuredText và Sphinx với autodoc, bởi vì tôi thực

29Nhiệt

3Trả lời

Làm cách nào để tham chiếu tham số hàm Python được ghi lại bằng cách sử dụng đánh dấu Sphinx?

Tôi muốn tham chiếu một tham số chức năng được ghi chép trước đó ở nơi khác trong một chuỗi tài liệu Python. Hãy xem xét ví dụ sau đây (phải thừa nhận hoàn toàn nhân tạo): def foo(bar): """Perfor

5Nhiệt

1Trả lời

autoclass và các thuộc tính dụ

Theo sphinx documentation, chỉ thị .. autoattribute sẽ có thể ghi lại các thuộc tính cá thể. Tuy nhiên, nếu tôi làm :: .. currentmodule:: xml.etree.ElementTree .. autoclass:: ElementTree .. au

6Nhiệt

1Trả lời

Tại sao CPython không sử dụng `sphinx.autodoc` cho thư viện chuẩn?

Tôi đang phát triển một thư viện python và tôi đang sử dụng sphinx.autodoc để tạo tài liệu vì tôi nghĩ rằng đây là cách tốt để không lặp lại chính mình và có tài liệu và mã theo thỏa thuận. Trong nhận

7Nhiệt

2Trả lời

Nhân sư: Danh sách các ngôn ngữ được hỗ trợ để làm nổi bật?

Tôi đang sử dụng Nhân sư cho tài liệu mã và sử dụng một số ngôn ngữ trong mã, tôi muốn thiết lập làm nổi bật cho tất cả mã đó. Nhân sư đề cập ngắn gọn một vài ngôn ngữ mà nó hỗ trợ (on this page), và

9Nhiệt

2Trả lời

Cách đơn giản nhất để chạy Nhân sư trên một tệp python

Chúng tôi có cấu hình Nhân sư sẽ tạo ra một loạt các tài liệu HTML cho toàn bộ codebase của chúng tôi. Đôi khi, tôi đang làm việc trên một tệp và tôi chỉ muốn xem đầu ra HTML từ tệp đó để đảm bảo rằng

9Nhiệt

1Trả lời

Sphinx autodoc cho CẢNH BÁO: py: không tìm thấy mục tiêu tham chiếu lớp: cảnh báo kiểu

Tôi có một số mã sử dụng một metaclass trong python. Nhưng khi autodoc Sphinx được chạy nó là đưa ra các lỗi: WARNING: py:class reference target not found: type Các lỗi đang xảy ra trong một dòng được

19Nhiệt

2Trả lời

Sphinx, sử dụng automodule để tìm submodules

Khi sử dụng automodule nhân sư của (http://sphinx.pocoo.org/ext/autodoc.html#directive-automodule), tôi chỉ đơn giản viết trong một tập tin .rst: .. automodule:: my_module :members: Tài liệu my