sphinx-me

sfinks-mig er et Python værktøj, der vil skabe en Sphinx dokumentation shell til dit projekt og omfatter README fil som dokumentation indeks. & Nbsp; Den håndterer udtrække de nødvendige metadata såsom projektets navn, forfatter og version fra din projekt til brug i dine Sphinx docs.
Når du bruger sfinks-mig til at opbygge din Sphinx docs, du kan derefter tilføje dit projekt til Læs anmeldelser af The Docs hjemmeside og få dit projekt README vært med en attraktiv Sphinx dokumentation tema.
Bemærk: Din README filen skal være i en reStructuredText kompatibelt format.
Installation
Den nemmeste måde at installere sfinks-mig, er direkte fra PyPI hjælp pip eller setuptools ved at køre den respektive kommandoen nedenfor:
pip installere -U sfinks-mig
eller:
easy_install -U sfinks-mig
Ellers kan du hente sfinks-mig og installere det direkte fra kilden:
python setup.py installere
Løb
sfinks-mig vil blive installeret som et hele systemet script, der kan køres fra kommandolinjen, mens i dit projekt rodmappe:
sfinks-mig
Når køre i dit projekt mappe, vil det skabe en docs mappe med to filer, Sphinx conf.py modul, og en index.rst fil, som vil omfatte dit projekts README.
Den conf.py modul kalder en opsætning funktion fra sphinx-me, der opsætter nødvendige indstillinger minimum for dine Sphinx docs.
- Projekt - mappen navnet på dit projekt bliver brugt.
- Version - hentet fra den version arg din setup.py script, eller din pakke er __version__ attribut.
- Copyright - hentet fra forfatteren arg din setup.py script, eller din pakke er __author__ attribut

Krav :

• . Python