search

OpenNTI / sphinxcontrib-programoutput

Sphinx extension for capturing program output
BSD 3-Clause "New" or "Revised" License
37 stars 17 forks source link

Option to change command that appears at prompt #37

Open h1nk opened 5 years ago

h1nk commented 5 years ago

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.

jamadden commented 5 years ago

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}".