sphinx-me

sphinx-me là một công cụ Python mà sẽ tạo ra một vỏ tài liệu Sphinx cho dự án của bạn và bao gồm các tập tin README như chỉ số tài liệu & nbsp;. Nó xử lý giải nén dữ liệu meta cần thiết như tên dự án, tác giả và phiên bản từ của bạn dự án để sử dụng trong tài liệu của bạn Sphinx.
Khi bạn sử dụng Sphinx-tôi để xây dựng tài liệu Sphinx của bạn, sau đó bạn có thể thêm vào dự án của bạn đến các trang web đọc Các Docs và có README của dự án của bạn được lưu trữ với một tài liệu chủ đề Sphinx hấp dẫn.
Lưu ý: file README của bạn phải ở trong một reStructuredText định dạng tương thích.
Cài đặt
Cách dễ nhất để cài đặt Sphinx-me là trực tiếp từ PyPI sử dụng pip hoặc setuptools bằng cách chạy lệnh tương ứng dưới đây:
pips cài đặt -U sphinx-me
hoặc:
easy_install -U sphinx-me
Nếu không, bạn có thể tải về Sphinx-me và cài đặt nó trực tiếp từ nguồn:
python setup.py cài đặt
Chạy
sphinx-me sẽ được cài đặt như là một kịch bản trên toàn hệ thống có thể được chạy từ dòng lệnh trong khi trong thư mục gốc của dự án của bạn:
sphinx-me
Khi chạy trong thư mục của dự án của bạn, nó sẽ tạo ra một thư mục docs với hai tập tin, các mô-đun conf.py Sphinx, và một file index.rst đó sẽ bao gồm README của dự án của bạn.
Các mô-đun conf.py gọi một chức năng thiết lập từ sphinx-me mà đặt lên các thiết lập cần thiết tối thiểu cho tài liệu của bạn Sphinx.
- Dự án - tên thư mục của dự án của bạn được sử dụng.
- Phiên bản - lấy từ arg phiên bản của kịch bản setup.py của bạn, hoặc thuộc tính __version__ gói hàng của bạn.
- Bản quyền - lấy từ arg tác giả của kịch bản setup.py của bạn, hoặc thuộc tính __author__ gói hàng của bạn

Yêu cầu :

• . Python