szfinx-számomra egy Python eszköz, amely megteremti a Szfinx dokumentációt shell a projekthez, és tartalmazza a README fájlban a dokumentáció index. & Nbsp; Kezeli kivonásához szükséges meta adatok, mint például a projekt neve, a szerző és a verziót a Project keretében a Szfinx docs.
Ha használ szfinx-me építeni a Szfinx docs, akkor majd add hozzá a projekt az olvassa el a Docs oldalon, és a projekt README házigazdája vonzó Sphinx dokumentációt témát.
Megjegyzés: A README fájlt kell a reStructuredText kompatibilis formátumban.
Telepítés
A legegyszerűbb módja annak, hogy telepítse szfinxszerű számomra közvetlenül PyPI segítségével pip vagy setuptools futtatásával az adott parancsot a következők:
pip telepíteni -U szfinx-me
vagy:
easy_install -U szfinx-me
Ellenkező esetben nem lehet letölteni szfinx-én és telepítse közvetlenül a forrásból:
python setup.py telepíteni
Futás
szfinx-me lesz telepítve a rendszerre kiterjedő script, ami futtatható a parancssorból, míg a projekt gyökérkönyvtárában:
szfinx-me
Amikor fut a projekt könyvtárba, ez létre fog hozni egy docs könyvtárban két fájl, a Szfinx conf.py modul, és egy index.rst fájlt, amely tartalmazza a projekt README.
A conf.py modul felhívja a beállítás funkciót szfinx-nekem, hogy létrehozza a minimálisan szükséges beállításokat a Szfinx docs.
- Projekt - a könyvtár nevét a projekt használják.
- Verzió - kiolvasni a verzió arg a setup.py script, illetve a csomag __version__ attribútum.
- Szerzői - kiolvasni a szerző arg a setup.py script, illetve a csomag __author__ attribútum.
követelmények :
- Python
Hozzászólás nem található