sphinx-me

sfinksen-me er et Python verktøy som vil skape en Sphinx dokumentasjon shell for prosjektet og inkluderer README-filen som indeksen dokumentasjon. & Nbsp; Det håndterer utpakking de nødvendige metadata som prosjektnavnet, forfatter og versjonen fra prosjekt for bruk i Sphinx docs.
Når du bruker sfinksen-me å bygge din Sphinx docs, du kan da legge prosjektet til Les The Docs området og har prosjektets README vert med en attraktiv Sphinx dokumentasjon tema.
Merk: VIKTIG-filen bør være i en reStructuredText kompatibelt format.
Installasjon
Den enkleste måten å installere sfinks-me er direkte fra PyPI bruker pip eller setuptools ved å kjøre den aktuelle kommandoen nedenfor:
Pip installere -U sphinx-me
eller:
easy_install -U sphinx-me
Ellers kan du laste ned sfinksen-meg og setter det direkte fra kilden:
python setup.py installere
Running
sfinks-me vil bli installert som en systemomfattende script som kan kjøres fra kommandolinjen mens i prosjektets rotkatalogen:
sphinx-me
Når du kjører i prosjekt katalog, vil det skape en docs katalog med to filer, Sfinxen conf.py modul, og en index.rst fil som vil omfatte prosjektets README.
Den conf.py modulen krever et oppsett funksjon fra Sphinx-me som setter opp et minimum av nødvendige innstillinger for Sphinx docs.
- Prosjekt - katalogen navnet på prosjektet er brukt.
- Versjon - hentet fra versjonen arg på setup.py script, eller din pakkens __version__ attributt.
- Copyright - hentet fra forfatteren arg på setup.py script, eller din pakkens __author__ attributt

Krav

• . Python