python-sphinx

10Nhiệt

2Trả lời

Tôi có mô-đun cần có số @property, tôi đã giải quyết điều này bằng cách đặt lớp làm mô-đun. Tôi có ý tưởng từ câu trả lời này: Lazy module variables--can it be done? Tôi muốn điều này có thể lặp lại v

12Nhiệt

4Trả lời

Bao gồm cụ thể đặc biệt-phương pháp trong nhân sư

tôi có một loạt các lớp học mà sử dụng "đặc biệt phương pháp": class Foo(object): "Foo docstring" attr1 = "Attribute!" #: first attribute attr2 = "Another Attribute!" #: second attribu

12Nhiệt

1Trả lời

Tự động xuất bản tài liệu sinh ra nhân sư trên wiki bitbucket?

Tôi có gói python với tài liệu do nhân tạo tạo ra (sử dụng tính năng tự động hóa) và nó có thể được tạo thành một tập hợp các trang html tĩnh nằm trong thư mục _build trong kho git của dự án. Tôi muốn

6Nhiệt

4Trả lời

Toctree điều kiện trong Sphinx

Tôi muốn thực hiện nhiều phiên bản tài liệu, khác với các phần được bao gồm. Để đạt được điều này, tôi thường sử dụng chỉ thị only hoặc tiện ích mở rộng ifconfig. Tuy nhiên, tôi không thể sử dụng bất

16Nhiệt

3Trả lời

Làm cách nào để ghi lại ngoại lệ bằng Sphinx

Tôi không thể tìm ra cách ghi lại ngoại lệ bằng Sphinx. Tôi đã thử những điều sau đây: def some_funct(): """ :raises: ExceptionType: Some multi-line exception description. """

6Nhiệt

4Trả lời

Ẩn phần phụ Nhân sư khỏi TOCTree chính

Có thể ẩn một (hoặc tất cả) các phần phụ có trong tệp RST từ TOCTree chính không? Hãy để tôi diễn tả nhiều hơn một chút: index.rst :doc:`Label <path/to/rst/file>` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

7Nhiệt

1Trả lời

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

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ã.

12Nhiệt

2Trả lời

Làm cách nào để ghi lại các lớp học mà không có tên mô-đun?

Tôi đang cố gắng ghi lại gói python với sphinx và đã tạo thành công tệp html. Gói tôi đang tạo tài liệu bao gồm tập hợp các tệp *.py, hầu hết chứa một lớp với một vài tệp là mô-đun chính hãng có chức

5Nhiệt

1Trả lời

Sử dụng bản thân để tạo một sơ đồ trang web với toctree trong nhân sư có vẻ bị hỏng?

Tôi đang cập nhật Câu hỏi thường gặp cho một dự án khá lớn và tôi muốn thêm chỉ mục các câu hỏi ở đầu trang để người dùng dễ dàng tìm thấy những gì họ đang tìm kiếm hơn. Tài liệu Sphinx toctree articl

7Nhiệt

2Trả lời

Nhân sư .. bao gồm cảnh báo :: chỉ thị và "trùng lặp nhãn"

Tôi đang cố sử dụng của để đưa tài liệu từ một tệp vào một tệp khác, để tránh sao chép văn bản nguồn của tài liệu. Phần tôi bao gồm là trong configuration.rst (nó là một phần của các tài liệu tham khả