Sphinx e argparse - script della riga di comando di autodocumentazione?

Question

Sto costruendo un pacchetto Python e usando Sphinx per creare i documenti. A parte il mio codice pacchetto, includo anche molti script Python a riga di comando, che usano argparse. Mi stavo chiedendo se c'è un modo per ottenere Sphinx per autocalizzare questi script? L'obiettivo finale sarebbe un elenco di script ben stampato, con la stampa, gli argomenti e le opzioni di aiuto associati. E per essere chiari, sto cercando un modo preesistente per farlo, non un modo per implementarlo da solo.

Questo non è specifico di una domanda, come di solito chiedo su S.O., se c'è un S.E. più appropriato. sito per pubblicare questa domanda, per favore fatemelo sapere. Grazie.

Answer 1

È possibile utilizzare sphinxcontrib.programoutput per includere i messaggi della guida dalla riga di comando nella documentazione.

Questo non è specifico per argparse ma può essere utilizzato per documentare qualsiasi messaggio di aiuto per la stampa di script sulla riga di comando.

Answer 2

Usa sfinge-argparse estensione:

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

Answer 3

È possibile utilizzare sphinxcontrib.autoprogram. pip install sphinxcontrib-autoprogram, poi mettere

extensions += ['sphinxcontrib.autoprogram'] 

nel vostro conf.py. Per documentare comando cli.py importando cli con l'argparse parser oggetto parser (che può essere un'espressione Python, come una funzione get_parser()), utilizzare

.. autoprogram:: cli:parser 
    :prog: cli.py