stsci.sphinxext chứa phần mở rộng Sphinx để xây dựng tài liệu hướng dẫn từ STScI.
Cách sử dụng
Những hướng dẫn này chỉ bao gồm những thay đổi từ các hướng dẫn Sphinx chuẩn.
Tạo ra một cây mới cho tài liệu của bạn Sphinx, sử dụng sphinx_quickstart, như được mô tả trong phần giới thiệu Sphinx.
Nhập khẩu các tùy chỉnh stsci_sphinx vào conf.py của dự án của bạn bằng cách chèn dòng sau ở đầu trang:
từ stsci.sphinxext.conf nhập khẩu *
Các "mở rộng" dòng trong conf.py của bạn cũng cần được sửa đổi để nó không ghi đè lên các phần mở rộng được xác định bởi stsci.sphinxext. Ví dụ, thay đổi:
phần mở rộng = ['sphinx.ext.autodoc']
đến:
phần mở rộng + = ['sphinx.ext.autodoc']
. Ngoài ra, bình luận ra 'html_theme' dòng, vì vậy dự án của bạn sẽ sử dụng một trong các stsci.sphinxext
Yêu cầu :
- Python
- Sphinx
- numpydoc
- Matplotlib
Bình luận không