sphinx-me

sphinx-me ay isang Python tool na lumikha ng isang Sphinx babasahin shell para sa iyong proyekto at isama ang Readme file bilang mga babasahin index. & Nbsp; Ito humahawak extracting ang kinakailangang data meta tulad ng pangalan ng proyekto, may-akda at mga bersyon mula sa iyong proyekto para sa paggamit sa iyong Sphinx docs.
Kapag gumamit ka ng sphinx-me na bumuo ng iyong Sphinx docs, maaari mong pagkatapos ay idagdag ang iyong mga proyekto sa site Read Ang Docs at may Readme iyong proyekto naka-host sa isang kaakit-akit Sphinx babasahin tema.
Note: ay dapat sa isang reStructuredText compatible format ng iyong Readme file.
Pag-install
Ang pinakamadaling paraan upang i-install ang sphinx-me ay direkta mula PyPI gamit pip o setuptools sa pamamagitan ng pagpapatakbo ng kani-utos sa ibaba:
PIP install U sphinx-me
o:
easy_install U sphinx-me
Kung hindi, maaari mong i-download sphinx-me at direktang i-install ito mula sa source:
python setup.py install
Pagpapatakbo
sphinx-me ay mai-install bilang isang system-wide script na maaaring tumakbo mula sa command line habang nasa root directory ng iyong proyekto:
sphinx-me
Kapag tumakbo sa direktoryo ng iyong proyekto, ito ay lumikha ng isang direktoryo docs na may dalawang mga file, ang conf.py module Sphinx, at isang index.rst file na kung saan ay isasama ang Readme iyong proyekto.
Ang conf.py module tawag sa isang function setup mula sphinx-me na set up sa minimum na kinakailangang setting para sa iyong Sphinx docs.
- Proyekto - ang pangalan ng direktoryo ng iyong proyekto ay ginagamit.
- Bersyon - nakuha mula sa bersyon arg ng iyong setup.py script, o __version__ attribute iyong package ni.
- Copyright - nakuha mula sa arg akda ng iyong setup.py script, o __author__ attribute iyong package ni

Kinakailangan :

• . Sawa