sphinx-me

Sfinks-me to narzędzie Pythona, który stworzy Sphinx dokumentacji powłoki dla swojego projektu i to plik README jako indeksu dokumentacji. & Nbsp; Obsługuje wydobywania wymagane dane meta takie jak nazwa projektu, autora i wersji z twojego projektu w celu wykorzystania w docs Sphinx.
Po użyciu Sfinks-mi zbudować swoje dokumenty Sphinx, można następnie dodać swój projekt na stronie Przeczytaj Docs i mają README twojego projektu odbyło się atrakcyjnym Sphinx dokumentacji tematu.
Uwaga: Plik README powinny być w formacie zgodnym reStructuredText.
instalacji
Najprostszym sposobem zainstalowania sfinks-me jest bezpośrednio z PyPI używając pip lub setuptools uruchamiając odpowiednie polecenie poniżej:
pip install -U mnie sfinks-
lub:
easy_install -U Sphinx-ME
W przeciwnym razie można pobrać sfinks-mi i zainstalować go bezpośrednio ze źródła:
python setup.py install
Uruchamianie
Sfinks-me zostanie zainstalowany jako skrypt całego systemu, które mogą być uruchamiane z linii poleceń, podczas gdy w głównym katalogu projektu:
Sfinks-me
Po uruchomieniu w katalogu Twojego projektu, będzie stworzenie katalogu docs z dwóch plików, moduł conf.py Sphinx, a index.rst pliku, który obejmie README twojego projektu.
Moduł conf.py wywołuje funkcję konfiguracji z sfinks-mi, które ustanawia minimalne wymagane ustawienia dla docs Sphinx.
- Projekt - Nazwa katalogu w projekcie jest używany.
- Wersja - pobierane z wersji na arg swojej setup.py skryptu lub atrybutu __version__ Twojego pakietu.
- Prawa autorskie - pobierane z autora arg swojego skryptu setup.py lub atrybutu __author__ Twojego pakietu

Wymagania :

• . Python