sphinx-me

sphinx-saya adalah alat Python yang akan membuat shell dokumentasi Sphinx untuk proyek Anda dan menyertakan file README sebagai indeks dokumentasi & nbsp;. Ini menangani penggalian data meta yang diperlukan seperti nama proyek, penulis dan versi dari Anda Proyek untuk digunakan dalam dokumen Sphinx Anda.
Setelah Anda menggunakan sphinx-saya untuk membangun docs Sphinx Anda, Anda kemudian dapat menambahkan proyek Anda ke situs Baca The Docs dan memiliki README proyek Anda host dengan menarik Sphinx dokumentasi tema.
Catatan: berkas README Anda harus berada dalam reStructuredText format yang kompatibel.
Instalasi
Cara termudah untuk menginstal sphinx-saya adalah langsung dari PyPI menggunakan pip atau setuptools dengan menjalankan perintah masing di bawah ini:
pip install -U sphinx-me
atau:
easy_install -U sphinx-me
Jika tidak, Anda dapat men-download sphinx-saya dan menginstalnya langsung dari sumber:
python setup.py install
Menjalankan
sphinx-me akan dipasang sebagai script seluruh sistem yang dapat dijalankan dari baris perintah sementara di direktori root proyek Anda:
sphinx-me
Ketika berjalan di direktori proyek Anda, itu akan membuat direktori docs dengan dua file, modul conf.py Sphinx, dan file index.rst yang akan mencakup README proyek Anda.
Modul conf.py panggilan fungsi pengaturan dari sphinx-saya yang menentukan minimum pengaturan yang diperlukan untuk docs Sphinx Anda.
- Proyek - nama direktori proyek Anda digunakan.
- Versi - diambil dari arg versi naskah setup.py Anda, atau __version__ atribut paket Anda.
- Hak cipta - diambil dari penulis arg naskah setup.py Anda, atau __author__ atribut paket Anda

Persyaratan :

• . Python