sphinx-me is een Python-tool die een Sphinx documentatie shell voor uw project zal leiden en ook de README-bestand als de documentatie index & nbsp;. Het behandelt de extractie van de benodigde meta-gegevens zoals de naam van het project, de auteur en versie van uw project voor gebruik in uw Sphinx docs.
Zodra u gebruik maken van sphinx-me te bouwen uw Sphinx docs, u kunt dan uw project aan het lezen De Docs site en hebben README van uw project gehost met een aantrekkelijk Sphinx documentatie thema.
Opmerking: Uw README-bestand moet worden in een reStructuredText compatibel formaat.
installatie
De makkelijkste manier om te installeren sphinx-me is rechtstreeks van PyPI met pip of setuptools door het uitvoeren van onder de desbetreffende opdracht:
pip installeren -U sphinx-me
of:
easy_install -U sphinx-me
Anders kunt u sphinx-me downloaden en installeren direct van de bron:
python setup.py installeren
Running
sphinx-me zal worden geïnstalleerd als een script hele systeem dat kan worden uitgevoerd vanaf de command line, terwijl in uw project root directory:
sphinx-me
Wanneer lopen in de directory van uw project, zal het een docs directory met twee bestanden, de Sfinx conf.py module en een index.rst bestand dat README van uw project zal creëren.
De conf.py module roept een setup functie van de sfinx-me, dat stelt de minimaal vereiste instellingen voor uw Sphinx docs.
- Project - de directory naam van uw project wordt gebruikt.
- Versie - opgehaald uit de versie arg van uw setup.py script of __version__ attribuut van uw pakket.
- Copyright - opgehaald uit de auteur arg van uw setup.py script of __author__ attribuut van uw pakket
Eisen
- . Python
Reacties niet gevonden