python-sphinx

22Nhiệt

1Trả lời

Không tạo chỉ mục mô đun "modindex" khi sử dụng Sphinx

Tôi gặp sự cố khi tạo thư mục tài liệu (html) bằng cách sử dụng nhân sư xây dựng. tôi đã cố gắng sphinx-build -b html source build cũng như make html nhưng trong cả hai trường hợp chỉ html-files s

7Nhiệt

1Trả lời

Giải quyết xung đột tên trong các tham chiếu trong Sphinx với intersphinx

Tôi đang viết tài liệu cho thư viện python của tôi Sử dụng nhân sư, tôi cũng đã thêm tài liệu nhân sư khác với intersphinx. Và nó hoạt động khá tốt, nhưng một vài chức năng của tôi được đặt tên giống

5Nhiệt

1Trả lời

Làm cách nào tôi có thể liệt kê các thành viên không có giấy tờ với nhân sư/tự động?

Tôi đang sử dụng nhân sư có phần mở rộng autodoc và muốn tạo một danh sách chỉ chứa các hàm thành viên không có giấy tờ trong một số mô-đun chứ không phải thành viên được tài liệu. tôi thành công có t

8Nhiệt

1Trả lời

cách chèn siêu dữ liệu vào Python-sphinx (công cụ tài liệu)

Tôi muốn chèn một số siêu dữ liệu (ví dụ: từ khóa, mô tả, tác giả) trong các trang web của tôi được tạo bởi Nhân sư. tôi thấy :fieldname: Field content trong tài liệu của Sphinx, nhưng tôi không có

20Nhiệt

1Trả lời

Làm thế nào để tạo một liên kết đến một tập tin trong rst với nhân sư?

Tôi đang viết một tài liệu và tôi muốn bao gồm các liên kết đến các tệp pdf hoặc lưu trữ zip. Làm thế nào tôi có thể đạt được điều đó bằng ngôn ngữ đầu tiên và nhân sư? Nếu tôi làm điều đó here is a p

33Nhiệt

1Trả lời

Cách mở rộng tất cả các phần phụ trên thanh bên toctree trong Sphinx

Tôi đã tự hỏi liệu có cách nào để mở rộng tất cả các phần phụ trong tiêu đề được bao gồm trong tệp index.rst không? Như một ví dụ, đây là cách nó là: Section 1 Section 2 Section 3 Và đây là cách t

11Nhiệt

2Trả lời

có liên kết bị hỏng báo cáo nhân sư

Khi xây dựng tài liệu html, làm thế nào để bạn buộc nhân sư báo cáo hoặc tạo lỗi, trên các liên kết không tồn tại? Cụ thể, tôi có các thuộc tính và phương thức trong dự án Python đã bị xóa hoặc đổi tê

10Nhiệt

1Trả lời

Nhân sư - kết hợp automodule và autoclass

Trừ khi tôi thiếu thứ gì đó, nhân vật automodule của Sphinx sẽ chỉ ghi lại các thành viên của một mô-đun chứ không phải các thuộc tính của các lớp được định nghĩa trong mô-đun đó. Có cách nào tự động

10Nhiệt

1Trả lời

Tham số tham chiếu trong tài liệu Python

Tôi sử dụng tính năng Nhân sư và tính năng tự động phát để đảm bảo chúng tôi có tài liệu tốt trong dự án của mình. Vì vậy, tôi quen thuộc với info field lists và tôi đã quen với việc sử dụng cross-ref

5Nhiệt

1Trả lời

loại phương thức hoàn trả Sphinx với các liên kết

Sử dụng cython cùng với -Xembedsignature=True có thể mang lại chữ ký trong docstrings theo hình thức: | mymethod(...) | MyCythonModule.mymethod(self, param1, MyCythonType param2, param3=None) -> Som