Sphinx y argparse - autodocumentación de scripts de línea de comando?

Question

Estoy compilando un paquete de Python y utilizando Sphinx para crear los documentos. Aparte de mi código de paquete, también incluyo una gran cantidad de scripts de Python de línea de comando, que usan argparse. Me preguntaba si hay una forma de hacer que Sphinx autodocumente estos scripts. El objetivo final sería una lista bastante impresa de scripts, con la ayuda asociada imprimir, argumentos y opciones. Y para ser claros, estoy buscando una forma preexistente de hacerlo, no una forma de implementarlo yo mismo.

Esto no es tan específico de una pregunta como suelo preguntar en S.O., si hay una S.E. sitio para publicar esta pregunta, házmelo saber. Gracias.

Answer 1

Puede usar sphinxcontrib.programoutput para incluir los mensajes de ayuda de la línea de comandos en su documentación.

Esto no es específico de argparse pero se puede utilizar para documentar cualquier mensaje de ayuda de impresión de scripts en la línea de comandos.

Answer 2

Uso de esfinge argparse extensión:

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

Answer 3

Usted puede utilizar sphinxcontrib.autoprogram. pip install sphinxcontrib-autoprogram, a continuación, poner

extensions += ['sphinxcontrib.autoprogram'] 

en su conf.py. Para documentar comando cli.py importando cli con el objeto argparse parserparser (que puede ser una expresión de Python, como una función get_parser()), utilice

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