Câu hỏi được gắn thẻ «python-sphinx»

Tôi ghét RST nhưng yêu nhân sư. Có cách nào nhân sư đọc markdown thay vì reSturationuredText không?

212 python  markdown  python-sphinx 

Tôi đang cố gắng sử dụng Sphinx để ghi lại dự án hơn 5.000 dòng trong Python. Nó có khoảng 7 mô-đun cơ sở. Theo như tôi biết, để sử dụng autodoc, tôi cần viết mã như thế này cho mỗi tệp trong dự án của mình: .. automodule:: mods.set.tests …

149 python  python-sphinx  autodoc 

Làm cách nào để chèn tham chiếu chéo trong trang reST / Sphinx vào tiêu đề phụ hoặc liên kết trong một trang khác trong cùng một bộ tài liệu?

110 python-sphinx  restructuredtext 

Sphinx không tạo tài liệu cho __init __ (self) theo mặc định. Tôi đã thử những cách sau: .. automodule:: mymodule :members: và ..autoclass:: MyClass :members: Trong conf.py, cài đặt sau chỉ nối chuỗi doc_init __ (self) vào chuỗi docstring của lớp ( tài liệu tự động mã Sphinx dường …

107 python  python-sphinx  autodoc 

Tôi đang cố gắng bắt đầu với Sphinx và dường như gặp phải những vấn đề không ngừng. Chỉ huy: docs/sphinx-quickstart Tôi trả lời tất cả các câu hỏi và mọi thứ hoạt động tốt. Chỉ huy: docs/ls Mọi thứ trông bình thường. Kết quả:build Makefile source Chỉ huy: sphinx-build …

104 python  python-sphinx  autodoc 

Tôi đang sử dụng sphinx và plugin autodoc để tạo tài liệu API cho các mô-đun Python của mình. Trong khi tôi có thể thấy cách ghi lại các thông số cụ thể một cách độc đáo, tôi không thể tìm thấy một ví dụ nào về cách ghi lại …

99 python  python-sphinx  autodoc 

Đã đóng cửa . Câu hỏi này cần được tập trung hơn . Nó hiện không chấp nhận câu trả lời. Bạn muốn cải thiện câu hỏi này? Cập nhật câu hỏi để câu hỏi chỉ tập trung vào một vấn đề bằng cách chỉnh sửa bài đăng này . …

94 python  documentation  doxygen  docstring  python-sphinx 

Tôi đang cố gắng tạo một danh sách lồng nhau đúng cách bằng mã sau (sau các tài liệu về Sphinx và docutils ): 1. X a. U b. V c. W 2. Y 3. Z Tôi mong đợi điều này sẽ dẫn đến kết quả trong hai OLgiây nhưng …

90 markup  restructuredtext  python-sphinx 

Tôi đang sử dụng Sphinx để ghi lại một dự án không phải Python. Tôi muốn phân phối ./doccác thư mục trong mỗi mô-đun con, chứa submodule_name.rstcác tệp để ghi lại mô-đun đó. Sau đó, tôi muốn đưa các tệp đó vào hệ thống phân cấp chính để tạo thông …

90 python  python-sphinx 

Tôi muốn thêm liên kết đến một phương thức trong lớp của mình từ bên trong docstring của một phương thức khác cùng lớp. Tôi muốn liên kết hoạt động trong sphinx và ưu tiên cũng trong Spyder và các IDE Python khác. Tôi đã thử một số tùy chọn …

87 python  python-sphinx  spyder 

Làm cách nào để bạn định dạng văn bản trong một liên kết được biểu thị trong reStructuredText? Cụ thể, tôi muốn tạo HTML sau từ lần đầu tiên của mình: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> Kết quả sẽ như thế này: optparse.OptionParser tài liệu trong đó phần "optparse.OptionParser" ở phông …

81 python-sphinx  restructuredtext 

Việc xây dựng các tài liệu Nhân sư trên các tài liệu đã đọc bị lỗi với lỗi sau (nhật ký hoàn chỉnh bên dưới): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) Tôi đã làm điều gì sai hay đây là một lỗi trong tài liệu đọc? Một bản …

25 python  python-sphinx  read-the-docs 

Vui lòng tải xuống tệp simple.7zvà cài đặt trong nhân sư của bạn để tái tạo các vấn đề tôi mô tả ở đây, để sao chép nó, bạn có thể chạy: make clean make html tải xuống và cài đặt trong nhân sư của bạn để tái tạo các …

14 python  python-sphinx