sphinx-me

сфинкс ме е инструмент, Python, че ще създаде Sphinx документация корпус за вашия проект и включва файла README като индекс на документацията & Nbsp;. Той се справя извличане на необходимите мета данни като име на проекта, автор и версия от вашия проект за използване във вашите Сфинкс Документи.
След като използвате сфинкс ми да изгради своя Сфинкс документи, а след това можете да добавите вашия проект до мястото на прочете Docs и имат README вашия проект бе домакин с атрактивна Sphinx тема документация.
<Силен> Забележка: Вашият README файл трябва да бъде в reStructuredText съвместим формат.
<Силен> Инсталиране
Най-лесният начин за инсталиране на сфинкс ми е директно от PyPI използване на PIP или setuptools като пуснете съответната команда по-долу:
PIP инсталирате -U сфинкс-ми
или:
easy_install -U сфинкс-ми
В противен случай можете да изтеглите сфинкс-ми и да го инсталирате директно от източника:
питон setup.py инсталиране
<Силен> Running
сфинкс-ми ще бъде инсталиран като скрипт, който може да се управлява от командния ред, докато във вашия проект е главната директория на цялата система:
сфинкс-ми
Когато тичам в директорията на вашия проект, той ще създаде директория Docs с два файла, conf.py модул Сфинкса и index.rst файл, който ще включва README вашия проекта.
The conf.py модул призовава функция за настройка от сфинкс ми се, че се създава необходимия минимум настройки за вашите Сфинкс Документи.
- Проект - на името на директорията на вашия проект се използва.
- Версия - възстановен от версия Arg на вашия setup.py скрипт, или __version__ атрибут вашия пакета.
- Авторско право - възстановен от автора Arg на вашия setup.py скрипт, или __author__ атрибут вашия пакета

<силни> Изисквания

• . Python