sphinx-me

сфінкса мене інструмент Пітона, яка створить документації оболонку Sphinx для вашого проекту і включити файл README в якості індексу документації & NBSP ;. Він обробляє вилучення необхідних мета дані, такі як ім'я проекту, автор і версію з вашого Проект для використання у вашій документації сфінкса.
Після того, як ви використовуєте сфінкса-мені побудувати свої документи Сфінкс, то Ви можете додати свій проект на сайт Читайте Docs і мають 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