python-sphinx

7Nhiệt

2Trả lời

Trang web chính thức của Python cung cấp tải xuống tài liệu PDF, nhưng chúng được phân tách theo các chương. Tôi đã tải xuống mã nguồn và xây dựng tài liệu PDF, cũng là các tệp PDF riêng biệt. Làm thế

15Nhiệt

1Trả lời

Nhân sư không tìm thấy gói Python khi sử dụng autodoc

Tôi đang cố gắng tạo tài liệu cho dự án Python thử nghiệm trước khi thực hiện nó cho dự án thực. Hệ thống của tôi: Win7 64 bit, python 2.7.5 64 bit. Tên dự án của tôi là testDoc. Nó bao gồm pakage pyt

5Nhiệt

1Trả lời

Sphinx: lỗi trên một ứng dụng có sử dụng bình đăng nhập

Khi chạy Sphinx để tạo ra tài liệu trên một ứng dụng có sử dụng bình đăng nhập, tôi nhận được lỗi ~/workspace/doc/source$ make html ... File "/Users/prschmid/.virtualenvs/myproject/lib/python2.7/si

5Nhiệt

2Trả lời

Cách thêm thẻ kiểu blog trong reStructuredText bằng Sphinx

Đối với dự án tài liệu ngôn ngữ lập trình được viết bằng reStructuredText và được hiển thị thành HTML bằng Sphinx, tôi muốn nhóm các chức năng của mình thành các nhóm logic như: String (tất cả các hàm

6Nhiệt

3Trả lời

python-Sphinx: làm thế nào để hiển thị mã lệnh linux snippets

Sử dụng Sphinx, tôi biết bạn có thể hiển thị một mảnh đoạn mã python hoặc đoạn mã ruby bằng cách có một cái gì đó như: .. code-block:: ruby. ${your ruby code goes here} Làm thế nào tôi có thể

6Nhiệt

2Trả lời

tài liệu Sphinx và autodoc-skip thành viên

Tôi đang xây dựng nhân sư doc của tôi cho một dự án django theo cách sau: sphinx-apidoc app -o docs/source/app --force Bây giờ nó bao gồm tất cả nhân công nhập cư Nam mà tôi không muốn có trong tài

5Nhiệt

3Trả lời

Làm cách nào để tránh cảnh báo "SEVERE: Duplicate ID" cho các mô-đun autodoc'd của tôi trong Sphinx?

Tôi đang sử dụng RST/Sphinx tài liệu Python của tôi, tuy nhiên khi xây dựng nó ném cảnh báo như ...Code/doc/code.rst:3: SEVERE: Duplicate ID: "module-toast". My Python file nguồn được ghi nhận như s

7Nhiệt

1Trả lời

Hãy giá trị mặc định autodoc chương trình nhân sư trong các thông số mô tả

Tôi có docstring sau: def progress_bar(progress, length=20): ''' Returns a textual progress bar. >>> progress_bar(0.6) '[##########--------]' :param progress: Number between

8Nhiệt

1Trả lời

Làm cách nào để tạo tài liệu cho trình thiết lập thuộc tính Python bằng Sphinx?

Tôi có một cái gì đó lớp Python như sau, với docstrings dự định sẽ được chuyển đổi thành tài liệu bằng cách Sphinx: class Direction(object): """ A direction in which movement can be made.

8Nhiệt

2Trả lời

Nhân sư: Cách chính xác để lập tài liệu về enum?

Nhìn qua C and C++ domains của Nhân sư, nó dường như không có hỗ trợ gốc cho tài liệu enums (và ít enums ẩn danh nhiều hơn). Hiện tại, tôi sử dụng cpp:type:: cho loại enum và sau đó là danh sách tất c