sphinx-me

Sphinx-me je Python nástroj, který bude vytvářet Sphinx dokumentace shell pro váš projekt a zahrnout soubor README jako index dokumentace. & Nbsp; to zvládá extrakci požadovaných meta data jako je název projektu, autor a verze z vašeho Projekt pro použití ve vašich Sphinx docs.
Jakmile budete používat Sphinx-me stavět své Sphinx dokumenty, pak můžete přidat svůj projekt na stránkách Read Docs a má README vašeho projektu hostil s atraktivním Sphinx téma dokumentace.
Poznámka: Vaše README soubor by měl být v kompatibilním formátu reStructuredText.
Instalace
Nejjednodušší způsob, jak nainstalovat Sfinx-me je přímo od PyPI pomocí PIP nebo setuptools spuštěním příslušného příkazu níže:
Pip nainstalovat -U sfinga-me
nebo:
easy_install -U sfinga-ME
V opačném případě si můžete stáhnout sfinga-mi a nainstalujte jej přímo od zdroje:
python setup.py nainstalovat
Běh
sfinga-me bude instalován jako skriptu celého systému, které lze spustit z příkazového řádku, zatímco v kořenovém adresáři vašeho projektu:
sfinga-me
Při spuštění v adresáři vašeho projektu, vytvoří adresář docs se dvěma soubory, na conf.py modulu Sphinx, a index.rst souboru, který bude obsahovat README vašeho projektu.
Conf.py modul volá funkci nastavení z sfingy-me, který nastavuje minimální požadované nastavení pro vaše Sphinx dokumenty.
- Projekt - název adresáře vašeho projektu je použita.
- Verze - načtena z verze Arg vašeho setup.py skriptu, nebo vašeho balíku __version__ atributu.
- Copyright - získat od autora Arg vašeho setup.py skriptu, nebo vašeho balíku __author__ atributu

Požadavky na :

• . Python