pydoctor - Trực tuyến trên đám mây

CHƯƠNG TRÌNH:

TÊN

pydoctor - Trình tạo tài liệu API cho Python

SYNOPSIS

y tá [lựa chọn]

MÔ TẢ

Pydoctor là một trình tạo tài liệu API hoạt động chủ yếu bằng phân tích tĩnh.

Nó được viết chủ yếu để thay thế epydoc cho các mục đích của dự án Twisted như
epydoc gặp khó khăn với zope.interface, nhưng có thể được sử dụng cho mã Python không phải Zope như
tốt.

LỰA CHỌN

-h, --Cứu giúp
hiển thị thông báo trợ giúp này và thoát

-c TẬP TIN CẤU HÌNH, --config=TẬP TIN CẤU HÌNH
Sử dụng cấu hình từ tệp này (bất kỳ tùy chọn dòng lệnh nào ghi đè cài đặt từ
nộp).

-p ĐẦU VÀO, --input-dưa chua=ĐẦU VÀO
Tải hệ thống từ tệp pickle này (mặc định: không có, một hệ thống trống được tạo).

-o ĐẦU RA, - đầu ra-dưa chua=ĐẦU RA
Lưu hệ thống vào tệp dưa chua này (mặc định: không có, hệ thống không được lưu bởi
mặc định).

--hệ thống bổ sung=SYS: URLPREFIX
Tìm kiếm các đối tượng trong hệ thống này để. Liên kết đến các đối tượng này sẽ có URLPREFIX
ưu tiên cho họ.

- cấp hệ thống=HỆ THỐNG
Tên lớp có dấu chấm để sử dụng để tạo hệ thống.

--Tên dự án=TÊN DỰ ÁN
Tên dự án, xuất hiện trong html.

--Dự án URL=DỰ ÁN URL
Url của dự án, sẽ xuất hiện trong html nếu được cung cấp.

--project-base-dir=DỰ ÁN
Đường dẫn tuyệt đối đến thư mục cơ sở của dự án. Các liên kết nguồn sẽ được tính toán
dựa trên giá trị này.

--kiểm tra
Đừng phàn nàn nếu việc chạy không có bất kỳ tác dụng nào.

--pdb Giống như py.test's --pdb.

--make-html
Sản xuất đầu ra html.

--người phục vụ
Cung cấp HTML trên máy chủ cục bộ.

--cổng máy chủ=CỔNG MÁY CHỦ
Cổng cho --người phục vụ để sử dụng.

--local-chỉ
Chỉ ràng buộc máy chủ với máy chủ cục bộ.

--faced-path=FACING_PATH
Thiết lập VHostMonster, với tất cả sự nhầm lẫn ngụ ý.

--chỉnh sửa Khi phân phát HTML, hãy cho phép chỉnh sửa.

--Không kiểm tra
Khi cung cấp HTML và cho phép chỉnh sửa, trước tiên đừng kiểm tra tất cả các docstrings.

- gói phụ=ĐÓNG GÓI
Thêm một gói vào hệ thống. Có thể được lặp lại để thêm nhiều hơn một gói.

--add-mô-đun=MODULE
Thêm một mô-đun vào hệ thống. Có thể được lặp lại.

- gói trước=TRẢ GÓP TRƯỚC
Giả sử rằng tất cả các gói đều nằm trong gói này. Có thể được sử dụng để ghi lại một phần của
Gói.

--solve-bí danh
Điều này cập nhật các tham chiếu đến các lớp được nhập từ một mô-đun mà chúng được
được nhập vào các tham chiếu đến nơi chúng được xác định.

--abbreviate-đặc biệt=BẢN ĐỒ VIẾT TẮT
Đây là danh sách các cặp key = value được phân tách bằng dấu phẩy. Trường hợp bất kỳ khóa nào tương ứng với một
tên và giá trị mô-đun là chữ viết tắt mong muốn. Điều này có thể được sử dụng để giải quyết
xung đột với chữ viết tắt trong đó bạn có hai hoặc nhiều mô-đun bắt đầu bằng
cùng một bức thư. Ví dụ: twistcaldav = tcd.

--docformat=TÀI LIỆU
Các docstrings định dạng được epydoc hỗ trợ được giả định là.

--html-chủ đề=ĐỐI TƯỢNG HTML
Tên đầy đủ của đối tượng để tạo tài liệu API cho (mặc định: mọi thứ).

--html-trang-tóm tắt
Chỉ tạo các trang tóm tắt.

--html-write-function-trang
Tạo các tệp HTML riêng lẻ cho mọi chức năng và phương pháp. Họ không được liên kết với trong
bất kỳ HTML nào được tạo bởi pydoctor, nhưng chúng có thể hữu ích cho liên kết của bên thứ ba.

--html-đầu ra=ĐẦU RA HTML
Thư mục lưu các tệp HTML vào (mặc định là 'apidocs')

--html-nhà văn=NGƯỜI VIẾT HTML
Tên chấm của lớp người viết html để sử dụng (mặc định 'pydoctor.nevowhtml.NevowWriter',
yêu cầu Divmod Nevow được cài đặt).

--html-viewsource-base=HTMLNGUỒN CƠ SỞ
Đây phải là đường dẫn đến trình duyệt trac cho phần đầu của thanh toán svn mà chúng tôi đang sử dụng
tài liệu một phần của.

--html-sử dụng-sắp xếp
Sử dụng thư viện JS có thể sắp xếp để tạo các bảng nội dung gói, mô-đun và lớp
có thể sắp xếp

--html-use-splitlinks
Tạo JavaScript (không phân tán) để cho phép các phương thức lớp được hiển thị trong một
bảng trên mỗi lớp cơ sở hoặc trong một bảng lớn.

--html-danh sách rút gọn
Tạo JavaScript (không phân tán) để ẩn một số mục nhập trong danh sách dài
ví dụ: các lớp con.

- kiểm tra
Nhập và kiểm tra các mô-đun quá. XXX hiện không hoạt động

-v, --dài dòng
Ồn ào hơn. Có thể được lặp lại để có nhiều tiếng ồn hơn.

-q, --Yên lặng
Hãy im lặng hơn.

--tự động Chế độ tự động: phân tích tất cả các mô-đun và gói trong thư mục làm việc hiện tại
và chạy một máy chủ cục bộ cho phép kiểm tra và chỉnh sửa các docstrings.

--verbose-về=giai đoạn
Hãy ồn ào trong một giai đoạn thế hệ cụ thể.

Sử dụng pydoctor trực tuyến bằng các dịch vụ onworks.net