"Sfinksas-man yra Python įrankis, kuris sukurs Sphinx dokumentacijos apvalkalas savo projektą ir įtraukti README failą kaip dokumentų rodyklę. & Nbsp; Jis tvarko gavybos reikiamus meta duomenis, pavyzdžiui, projekto pavadinimas, autorius ir versijos iš savo Projektas skirtas naudoti jūsų Sphinx docs.
Kai jūs naudojate sfinksininėmis man kurti savo Sphinx docs, tada jūs galite pridėti savo projektą prie Skaityti Docs svetainę ir turėti savo projekto README vyko su patrauklia Sfinksas dokumentacijos tema.
Pastaba: Readme failas turi būti suteikta reStructuredText suderinamu formatu.
Diegimas
Paprasčiausias būdas įdiegti sfinksininėmis man yra tiesiogiai PyPI naudojant pip ar setuptools paleidę atitinkamą komandą žemiau:
PIP įdiegti -U sfinksas-me
arba:
easy_install -U sfinksas-me
Priešingu atveju galite parsisiųsti sfinksininėmis mane ir ją įdiegti tiesiai iš šaltinio:
pitonas setup.py įdiegti
"Running"
Sfinksas, man bus įdiegta kaip visos sistemos scenarijų, kuris gali būti paleisti iš komandinės eilutės, o jūsų projekto kataloge:
sfinksininėmis mane
Kai paleisti savo projekto katalogą, ji sukurs docs su dviem failus, Sfinksas conf.py modulis, ir index.rst failą į kurį bus įtraukti savo projekto README.
Conf.py modulis ragina sąrankos funkciją nuo sfinkso-man, kad įkuria minimalus reikalaujamas nustatymus savo Sphinx docs.
- Projektas - katalogas pavadinimas savo projektą naudojamas.
- Versija - gauti iš versijų Arg savo setup.py scenarijų, ar jūsų siuntos __version__ atributas.
- Autorių teisės - gauti iš autoriaus Arg savo setup.py scenarijų, ar jūsų siuntos __author__ atributas
Reikalavimai
- . Pitonas,
Komentarai nerastas