stsci.sphinxext berisi ekstensi untuk Sphinx untuk membangun dokumentasi dari STScI.
Penggunaan
Instruksi ini hanya mencakup perubahan dari petunjuk Sphinx standar.
Membuat pohon baru untuk dokumentasi Sphinx Anda, menggunakan sphinx_quickstart, seperti yang dijelaskan dalam pengenalan Sphinx.
Impor kustomisasi stsci_sphinx ke conf.py proyek Anda dengan memasukkan baris berikut di atas:
dari stsci.sphinxext.conf impor *
The "ekstensi" baris dalam conf.py Anda juga harus dimodifikasi sehingga tidak menimpa ekstensi didefinisikan oleh stsci.sphinxext. Misalnya, mengubah:
ekstensi = ['sphinx.ext.autodoc']
untuk:
ekstensi + = ['sphinx.ext.autodoc']
. Juga, komentar pada 'html_theme' line, sehingga proyek Anda akan menggunakan stsci.sphinxext satu
Persyaratan :
- Python
- Sphinx
- numpydoc
- Matplotlib
Komentar tidak ditemukan