сфинкса мне это инструмент Питона, которая создаст документации оболочку Sphinx для вашего проекта и включить файл README в качестве индекса документации & NBSP;. Он обрабатывает извлечения требуемых мета данные, такие как имя проекта, автор и версию с вашего Проект для использования в вашей документации сфинкса.
После того, как вы используете сфинкса-мне построить свои документы Сфинкс, то Вы можете добавить свой проект на сайт читать документы и имеют README вашего проекта состоялась с привлекательной Сфинкс документации теме.
Примечание: Ваш README файл должен быть в совместимом формате ReStructuredText.
Установка
Самый простой способ установить сфинкса-я прямо из PyPI помощью PIP или Setuptools выполнив соответствующую команду ниже:
пункт установить -U сфинкса меня
или:
easy_install -U сфинкса мне
В противном случае вы можете скачать сфинкса-меня и установить его непосредственно из источника:
питон setup.py установить
Запуск
Сфинкс-я будет установлен в качестве сценария общесистемного, которые могут быть запущены из командной строки, а в корневом каталоге вашего проекта:
Сфинкс-я
При запуске в каталоге вашего проекта, это создаст каталог Docs с двумя файлами, модуля conf.py Сфинкса, и в index.rst файл, который будет включать в себя README вашего проекта.
Conf.py модуль вызывает функцию установки из-сфинкса мне, что устанавливает минимальный необходимые настройки для вашей документации сфинкса.
- Проект - имя каталога вашего проекта используется.
- Версия - извлекается из версий аргумента вашего сценария setup.py, или __version__ атрибута вашего пакета.
- Авторские права - извлекается от автора аргумента вашего скрипта setup.py, или __author__ атрибута вашего пакета
Требования
- . Python
Комментарии не найдены