sphinx-me

sfinks-my is 'n Python instrument wat 'n Sphinx dokumentasie dop vir jou projek sal skep en sluit die README lêer as die dokumentasie indeks & nbsp;. Dit hanteer onttrek die vereiste meta data soos die projek naam, skrywer en weergawe van jou projek vir gebruik in jou Sphinx docs.
Sodra jy gebruik sfinks-me te bou om jou Sphinx docs, kan jy voeg dan jou projek aan die lees van die dokumente site en het README jou projek wat met 'n aantreklike Sphinx dokumentasie tema.
Nota: Jou README lêer moet wees in 'n reStructuredText versoenbaar formaat.
Installasie
Die maklikste manier om te installeer sfinks-my is direk van PyPI behulp pit of setuptools deur die loop onder die onderskeie opdrag:
PIP installeer -U sfinks-me
of:
easy_install -U sfinks-me
Andersins kan jy sfinks-me aflaai en installeer dit direk van die bron:
python setup.py installeer
Running
sfinks-my sal geïnstalleer as 'n script hele stelsel wat gebruik kan word uit die opdrag lyn, terwyl in jou projek se hoofdmap:
sfinks-me
Wanneer hardloop in die gids se projek, sal dit 'n docs gids met twee lêers, die Sphinx conf.py module, en 'n index.rst lêer wat README jou projek sal skep.
Die conf.py module roep 'n setup funksie van sfinks-my dat stel die minimum vereiste instellings vir jou Sphinx docs.
- Projek - die gids naam van jou projek gebruik word.
- Weergawe - opgespoor van die weergawe arg jou setup.py script, of __version__ kenmerk jou pakket.
- Kopiereg - opgespoor van die skrywer arg jou setup.py script, of __author__ kenmerk jou pakket

Vereistes :

• . Python