Sfinx și argint - scripturi de linie de comandă autococumentare?

Construiesc un pachet Python și folosesc Sfinx pentru a crea documentele. În afară de codul meu de pachete, includ, de asemenea, o mulțime de scripturi de linie de comandă Python, care utilizează argarse. Mă întrebam dacă există o modalitate de a obține Sfinxului la autocumentare aceste scripturi? Scopul final ar fi o listă cu scripturi destul de tipărite, cu ajutorul tipăririi ajutorului asociat, a argumentelor și a opțiunilor. Și pentru a fi clar, căut un mod pre-existent de a face acest lucru, nu o modalitate de a pune în aplicare acest lucru eu.

Aceasta nu este la fel de specifică a unei întrebări pe care o întreb, de obicei, în S.O., dacă există un S.E. site-ul pentru a posta această întrebare, vă rog să-mi spuneți. Mulțumiri.

0
Nu sunt legate, dar ar putea fi de ajutor. Verificați pachetul plac pe PyPI.
adăugat autor Mikko Ohtamaa, sursa
Nu cred că mă ajută cu asta, dar interesant, mulțumesc pentru heads-up.
adăugat autor jeremiahbuddha, sursa

3 răspunsuri

Puteți utiliza sphinxcontrib.autoprogram . pip install sphinxcontrib-autoprogram , apoi puneți

extensions += ['sphinxcontrib.autoprogram']

în conf.py . Pentru a documenta comanda cli.py imporând cli cu parserul parser argparse parser < , ca o funcție get_parser() , utilizați

.. autoprogram:: cli:parser
   :prog: cli.py
0
adăugat

Puteți utiliza sphinxcontrib.programoutput pentru a include mesajele de ajutor din linia de comandă din documentația dvs. .

Acest lucru nu este specific pentru argparse , dar poate fi folosit pentru a documenta orice mesaj de ajutor de tipărire a scriptului în linia de comandă.

0
adăugat

Utilizați extinderea sphinx-argparse:

http://sphinx-argparse.readthedocs.org/ro/latest/

0
adăugat
Excelent. Există o modalitate de a trata blocul de "utilizare" diferit? Pentru mine, a avea un bloc literal nu este corect.
adăugat autor orome, sursa
Și în timp ce sunt la el, ar fi frumos de ieșire pentru opțiunile potrivite ceea ce .. opțiunea :: produce: numai pavilioane (fără implicit indicat), aliniate tot drumul spre stânga cu mai puțin indentarea descrierii și schimbarea primei litere în capace și adăugarea unei perioade la sfârșit dacă nu este deja acolo (deoarece idiomul pentru - help trebuie să omiteți și să utilizați toate literele mici). De asemenea, probabil că intrările de pavilion care se potrivesc cu ajutorul ajută la o expunere mai strânsă (de exemplu, -colles [COL [COL ...]] , ma
adăugat autor orome, sursa
Se pare că a apărut o eroare: pastebin.com/jXAz1qHw
adăugat autor Martin Thoma, sursa
Python România
Python România
100 participanți

Comunitatea pasionaților de Python din România.