sphinx-me

sfinx-mi este un instrument Python care va crea o coajă de documentare Sfinx pentru proiectul dumneavoastră și să includă fișierul README ca indicele de documentare. & Nbsp; Se ocupa extragerea datelor meta necesare, cum ar fi numele proiectului, autorul și versiunea de dvs. proiect pentru utilizarea în documentele tale Sphinx.
După ce utilizați sfinx-mi să construiască documentele dvs. Sphinx puteti adauga proiectul la site Citește Docs și au README proiect a găzduit cu un atractiv Sphinx temă documentare.
Notă: Fișierul dvs. README trebuie să fie în format compatibil reStructuredText.
Instalare
Cel mai simplu mod de a instala Sphinx-mi este direct de la PyPI utilizarea pip sau setuptools prin rularea comenzii respective de mai jos:
PIP instala -U sfinx-mi
sau:
easy_install -U sfinx-mi
În caz contrar, puteți descărca sfinx-mi și instalați-o direct de la sursa:
python setup.py instala
alergare
sfinx-mi va fi instalat ca un script la nivel de sistem, care poate fi rulat din linia de comandă în timp ce în directorul rădăcină proiectul dumneavoastră:
sfinx-mi
Când executați în directorul proiectului dumneavoastră, se va crea un director documente cu două fișiere, modulul conf.py Sfinxul, și un fișier index.rst care va include README proiectul dumneavoastra.
Modulul conf.py solicită o funcție de configurare de la Sphinx-mi că stabilește minime setările necesare pentru documentele dumneavoastră Sphinx.
- Proiect - numele directorului de proiect este utilizat.
- Versiunea - preluate de la versiunea arg de script-ul dvs. setup.py, sau atribut __version__ pachetul dumneavoastră.
- Drepturi de autor - recuperat de autor arg de script-ul dvs. setup.py, sau atribut __author__ pachetul de

Cerințe :

• . python