sfinksi-minulle on Python työkalu, joka luo Sphinx dokumentaatiota kuori projektin ja sisältävät README tiedosto dokumentaatio indeksin. & Nbsp; Se käsittelee talteen tarvittavat meta tiedot, kuten projektin nimi, kirjailija ja versio teidän Projekti käytettäväksi oman Sphinx docs.
Kun käytät sfinksi-me rakentaa Sphinx docs, voit lisätä projektin Read dokumentit päällä ja pyydä projektin README isännöi houkutteleva sfinksi asiakirjat teema.
Huomaa: README-tiedostossa pitäisi olla reStructuredText yhteensopivaan muotoon.
asennus
Helpoin tapa asentaa sfinksi-me on suoraan PyPI käyttäen PIP tai setuptools ajamalla kunkin komennon alla:
PIP asentaa -U sfinksi-me
tai:
easy_install -U sfinksi-me
Muuten voit ladata sfinksi-me ja asenna se suoraan lähteestä:
python setup.py asentaa
Juoksu
sfinksi-me asennetaan järjestelmänä laajuinen skripti, joka voidaan ajaa komentoriviltä kun projektin juurihakemistossa:
sfinksi-me
Kun ajaa projektin hakemistoon, se luo docs hakemistoon kaksi tiedostoa, sfinksi conf.py moduulin, ja index.rst tiedosto, joka sisältää projektisi README.
Conf.py moduuli kutsuu setup toiminnon sfinksi-minulle, että luodaan vähimmäisvaatimus asetukset sfinksi docs.
- Projekti - hakemiston nimi projektin on käytetty.
- Versio - noudetaan versiosta arg teidän setup.py käsikirjoituksen, tai pakettisi __version__ määrite.
- Tekijänoikeus - noudetaan kirjoittaja arg teidän setup.py käsikirjoituksen, tai pakettisi __author__ määrite.
vaatimukset
- python
Kommentteja ei löytynyt