python-sphinx

13Nhiệt

1Trả lời

Tôi hiện đang ghi lại một API còn lại được viết bằng Python. Tất cả tài liệu của dự án được tạo ra bằng cách sử dụng Sphinx, và cho REST API tôi muốn tạo ra một số chỉ thị đặc biệt. Ví dụ: giả sử tôi

9Nhiệt

2Trả lời

Hỗ trợ RTL bằng Python Sphinx

Có cách nào để sử dụng văn bản RTL (Phải sang trái, như farsi, arabic, ...) trong sphinx không? Khi tạo html từ tệp .rst, html được tạo là LTR (Từ trái sang phải theo mặc định) và căn trái, và câu hỏi

10Nhiệt

3Trả lời

Chỉ định hình ảnh trực tuyến ở định dạng Nhân sư (định dạng lại)

Bất kỳ ý tưởng nào về cách tôi có thể tham chiếu đến hình ảnh trực tuyến trong khi ghi lại bằng Nhân sư? này không làm việc: .. image:: http://www.mysite.com/images/someimage.png Cung cấp cho tôi: /

6Nhiệt

1Trả lời

Tài liệu nhân sư: L ERI: Loại chỉ thị không xác định "chương trình-đầu ra"

Tôi đang cố tạo tài liệu của mình bằng Nhân sư và giờ trên hai máy tôi có cùng vấn đề chính xác: chỉ thị chương trình-đầu ra không hoạt động. Tôi đã cài đặt Sphinx, sau đó mở rộng programoutput: $ sud

8Nhiệt

1Trả lời

Override khai báo hàm trong autodoc cho Sphinx

Tôi có một mô-đun mà đi một cái gì đó như thế này: #!/usr/bin/env python #: Documentation here. #: blah blah blah foobar = r'Some really long regex here.' def myfunc(val=foobar): '''Blah bl

14Nhiệt

3Trả lời

Tạo tài liệu Tastypie

Tôi đang cố gắng sử dụng công cụ tự động hóa để tạo tài liệu API cho API REST ngon miệng. Tôi đã thử món ăn ngon, nhưng có vẻ như không hiển thị các thông số kết quả của api mà là các cột của mô hình.

6Nhiệt

2Trả lời

Nhân sư - Tài liệu mô hình Django

Tôi đang sử dụng Nhân sư để tạo tài liệu cho ứng dụng Django mà tôi có. Khi tạo tự động tài liệu, tôi muốn Nhân sư thêm các trường của mỗi mô-đun trong tài liệu. Nhân sư hoàn toàn bỏ qua chúng. Trong

20Nhiệt

1Trả lời

Vô hiệu hóa các thông báo cảnh báo Sphinx riêng lẻ

Tôi có nhiều tệp .rst trong cây Sphinx của mình bị cố ý loại trừ khỏi bất kỳ cây chỉ mục nào. Tôi nhận được cảnh báo như /filename.rst:: WARNING: document isn't included in any toctree Làm cách nào

32Nhiệt

2Trả lời

Nhân sư có phù hợp với tài liệu C++ không?

Tôi muốn thử các trình tạo tài liệu cho một dự án mới trong C++. Tôi nghĩ rằng các lựa chọn của tôi là Doxygen hoặc Sphinx. Vì tôi có các dự án trong Python mà tôi muốn sử dụng Sphinx, tôi tự hỏi liệu

6Nhiệt

2Trả lời

Nhân sư có chạy mã của tôi khi thực thi 'make html' không?

Tôi thừa kế một codebase khá lớn mà tôi muốn tạo tài liệu html cho. Vì nó được viết bằng Python, tôi quyết định sử dụng nhân sư vì người dùng mã đã quen với thiết kế và chức năng của tài liệu python đ