sphinxcontrib-programoutput icon indicating copy to clipboard operation
sphinxcontrib-programoutput copied to clipboard

Option to change command that appears at prompt

Open h1nk opened this issue 6 years ago • 1 comments

In my current use case I'm capturing the help output of a command within a project I'm documenting.

Something like so:

.. command-output:: python -m package.command --help

Which builds to:

$ python -m package.command --help

...

This works as expected, which is great. My problem however is that I really want to have the name of the setuputil's script entry-point appear at the prompt instead, as this is realistically how most users will invoke the command. It would be nice if an option could be added to modify/override the command that appears at the prompt.

h1nk avatar Jun 15 '19 17:06 h1nk

If you're only using the directive once, you could (ab)use programoutput_prompt_template in the sphinx setup to do this. Something like programoutput_prompt_template = "$ my_entry_point --help\n{output}".

jamadden avatar Jun 20 '19 12:06 jamadden