sfinx-me är ett Python verktyg som kommer att skapa en Sphinx dokumentation skal för ditt projekt och inkluderar README filen som dokumentation index. & Nbsp; Den hanterar extrahera de nödvändiga metadata såsom projektnamn, författare och version från Projektet för användning i din Sphinx docs.
När du använder sfinx-me att bygga din Sphinx dokument, du kan sedan lägga till ditt projekt till Read The Docs plats och har ditt projekt README värd med en attraktiv Sphinx dokumentation tema.
Obs! Din README filen ska vara i en ReStructuredText kompatibelt format.
Installation
Det enklaste sättet att installera sfinx-me är direkt från PyPI använder PIP eller setuptools genom att köra respektive kommandot nedan:
Pip installera U sfinx-me
eller:
easy_install -U sphinx-me
Annars kan du hämta sfinx-me och installera det direkt från källan:
python setup.py installera
Löpning
sfinx-me kommer att installeras som ett system för hela skript som kan köras från kommandoraden medan projektet rotkatalog:
sphinx-me
När det körs i ditt projekt katalog, kommer det att skapa en docs katalog med två filer, sfinxen conf.py modulen, och en index.rst fil som kommer att inkludera ditt projekt README.
Den conf.py Modulen kallar en inställningsfunktion från sfinx-me som sätter upp den minsta nödvändiga inställningar för dina Sphinx docs.
- Projekt - katalognamnet på ditt projekt används.
- Version - hämtas från version arg på din setup.py skript eller din paketets __version__ attribut.
- Upphovsrätt - hämtas från författaren arg på din setup.py skript eller din paketets __author__ attribut
Krav :
- . Python
Kommentarer hittades inte