sphinx-me

sfinks-me Sizin layihə üçün Sphinx sənədlər shell yaratmaq və README sənədlər göstəricisi kimi fayl & nbsp daxil olacaq ki, Python vasitədir. Bu layihə adı, müəllifi və versiyası tələb meta data çıxarılması emal Sizin Sizin Sphinx docs istifadə üçün layihə.
Siz istifadə sonra sfinks-me sonra Read The Docs site üçün layihə əlavə və layihənin README cəlbedici Sphinx sənədlərin mövzu ilə keçirilib ola bilər, sizin Sphinx docs qurmaq.
Qeyd: Sizin README fayl reStructuredText uyğun formatda olmalıdır.
Quraşdırma
en asan yol yüklemek üçün sfinks-me aşağıdakı müvafiq əmri çalışan tırtıl və ya setuptools istifadə PyPI birbaşa edir:
bərpa Pip -U sfinks-me
və ya:
easy_install -U sfinks mənə-
Əks halda-me sfinks download və mənbə birbaşa yüklemek:
python bərpa setup.py
Running
sphinx-me isə layihənin kök kataloq skript satırı çalıştırabilirsiniz bilər ki, bir sistem geniş script qurulacaq:
sfinks-me
Sizin layihənin kataloq çalıştırdığınızda, iki faylları, Sphinx conf.py modulu və layihənin README daxildir ki, bir index.rst faylı ilə docs kataloq yaradacaq.
conf.py modul bir quraşdırma funksiyası çağırır sfinks-me Sizin Sphinx docs üçün minimum Tələb olunan parametrlər müəyyən edir.
- Layihə - Sizin layihənin directory adı istifadə olunur.
- Version - Sizin setup.py script, və ya sizin paketin __version__ atributu versiyası Arg alınan.
- Copyright - Sizin setup.py script, və ya sizin paketin __author__ atributu müəllifi Arg alınan

tələblər

• . Python