sphinx-me

sphinx-me ist ein Python-Tool, das eine Sphinx Dokumentation Schale für Ihr Projekt zu erstellen und die Readme-Datei als Dokumentation Index & nbsp wird;. Es behandelt das Extrahieren der erforderlichen Metadaten wie der Projektname, Autor und Version von Ihrem Projekt für den Einsatz in Ihrem Sphinx docs.
Sobald Sie verwenden sphinx-me, um Ihren Sphinx docs bauen, können Sie fügen Sie dann Ihr Projekt in die lesen Sie die Dokumentation und Website haben Ihres Projekts README mit einem attraktiven Sphinx Dokumentation Thema veranstaltet.
Hinweis: Ihre Readme-Datei sollte in einem reStructuredText kompatiblen Format vorliegen.
Installation
Der einfachste Weg, zu installieren sphinx-me ist direkt von PyPI mit pip oder Setuptools, indem Sie den entsprechenden Befehl im Handumdrehen:
pip installieren -U sphinx-me
oder:
easy_install -U sphinx-me
Ansonsten können Sie sphinx-me herunterladen und installieren direkt von Quelle:
python setup.py install
Ausführen
sphinx-me wird als systemweiten Skript, das von der Kommandozeile, während im Stammverzeichnis Ihres Projekts ausgeführt werden können installiert werden:
sphinx-me
Wenn im Verzeichnis Ihres Projektes ausführen, wird es eine docs Verzeichnis mit zwei Dateien, die Sphinx conf.py Modul und einem index.rst Datei, die Ihr Projekt README umfassen wird zu erstellen.
Die conf.py Modul ruft eine Setup-Funktion aus sphinx-me, die bis setzt die minimale erforderliche Einstellungen für Ihre Sphinx docs.
- Projekt - der Verzeichnisname des Projekts verwendet wird.
- Ausführung - von der Version arg Ihrer setup.py Script oder __version__ Attributs Ihr Paket abgerufen.
- Urheberrecht - vom Autor arg Ihrer setup.py Script oder __author__ Attributs Ihr Paket abgerufen

Anforderungen :

• . Python