sfenks-me projeniz için bir Sfenks dokümantasyon kabuk oluşturmak ve README belgeleri indeksi dosyayı & nbsp içerecektir bir Python aracıdır;. Böyle proje adı, yazar ve sürüm olarak gerekli meta veri ayıklamak kolları senin senin Sfenks docs kullanmak için proje.
Kullandığınız kez sfenks-me sonra Oku Dokümanlar sitesine proje ekleyin ve projenizin README çekici bir Sfenks dokümantasyon tema ile barındırılan olabilir, senin Sfenks dokümanlar oluşturmak için.
Not: README dosyası reStructuredText uyumlu bir formatta olmalıdır.
Kurulum
en kolay yolu kurmak için sfenks-me aşağıda ilgili komutunu çalıştırarak pip veya setuptools kullanarak PyPI doğrudan geçerli:
install pip U sfenks-me
ya:
easy_install U sfenks bana-
Aksi takdirde-me Sfenks indirebilir ve doğrudan kaynağından yüklemek:
Python yüklemek setup.py
Koşu
sfenks-me ederken projenizin kök dizininde komut satırından çalıştırılabilir bir sistem çapında komut dosyası olarak kurulacaktır:
sfenks-me
Projenizin dizininde çalıştırdığınızda, iki dosya, Sfenks conf.py modülü ve projenizin README içerecek bir index.rst dosyası ile bir docs dizin oluşturacaktır.
conf.py modülü bir kurulum işlevi çağıran sfenks-bana Sfenks docs için minimum gerekli ayarlar kurar.
- Proje - projenizin dizin adı kullanılır.
- Sürümü - senin setup.py komut, ya da paketinizin __version__ niteliğin sürümü arg alınan.
- Telif hakkı - senin setup.py komut, ya da paketinizin __author__ niteliğin yazarı arg alınan
Gereksinimleri :
- . Python
Yorum Bulunamadı