Command 'python --help' failed: [Errno 2] No such file or directory: 'python'
│ │ │ │ │ │ │ │ │Normally the command is splitted according to the POSIX shell syntax (see
│ │ │ -shlex), and executed directly. Thus special shell features like
│ │ │ +shlex), and executed directly. Thus special shell features like
│ │ │ expansion of environment variables will not work:
.. command-output:: echo "$USER"
│ │ │ $ echo "$USER"
│ │ │ $USER
│ │ │ To enable these features, enable the shell option. With this option, the
│ │ │ command is literally passed to the system shell:
.. command-output:: echo "$USER"
│ │ │ :shell:
│ │ │ $ echo "$USER"
│ │ │ -buildd
│ │ │ +builduser
│ │ │ Other shell features like process expansion consequently work, too:
│ │ │.. command-output:: ls -l $(which grep)
│ │ │ :shell:
│ │ │ $ ls -l $(which grep)
│ │ │ --rwxr-xr-x 1 root root 198976 Jan 29 09:31 /bin/grep
│ │ │ +-rwxr-xr-x 1 root root 198976 Jan 29 2020 /bin/grep
│ │ │ Remember to use shell carefully to avoid unintented interpretation of shell
│ │ │ syntax and swallowing of fatal errors!
returncode option:
│ │ │ .. command-output:: python -c 'import sys; sys.exit(1)'
│ │ │ :returncode: 1
│ │ │ The above command returns the exit code 1 (as given to sys.exit()),
│ │ │ +
The above command returns the exit code 1 (as given to sys.exit()),
│ │ │ but no warning will be emitted. On the contrary, a warning will be emitted,
│ │ │ should the command return 0!
Note
│ │ │Upon fatal errors which even prevent the execution of the command neither │ │ │ return code nor command output are available. In this case an error message │ │ │ is inserted into the document instead.
│ │ │ @@ -194,15 +194,15 @@ │ │ │.. program-output:: command¶Include the output of command in the documentation.
The output is formatted as literal text, without any syntax highlighting.
│ │ │By default, the command is split according to the POSIX shell syntax (using
│ │ │ -shlex.split()), and executed directly. Both standard output and
│ │ │ +shlex.split()), and executed directly. Both standard output and
│ │ │ standard error are captured from the invocation of command and included
│ │ │ in the document. However, if the option shell is given, command is
│ │ │ literally passed to the system shell. With the nostderr option,
│ │ │ standard error is hidden from the output.
The working directory of the command can be configured with the cwd
│ │ │ option. The argument of this option is a directory path, relative to the
│ │ │ current source file. Absolute paths are interpreted as relative to the
│ │ ├── ./usr/share/doc/python-sphinxcontrib.programoutput-doc/html/searchindex.js
│ │ │ ├── js-beautify {}
│ │ │ │ @@ -103,15 +103,15 @@
│ │ │ │ binari: 0,
│ │ │ │ block: 0,
│ │ │ │ both: 0,
│ │ │ │ branch: 0,
│ │ │ │ bsd: 0,
│ │ │ │ bug: 0,
│ │ │ │ build: 0,
│ │ │ │ - buildd: 0,
│ │ │ │ + buildus: 0,
│ │ │ │ busi: 0,
│ │ │ │ calledprocesserror: 0,
│ │ │ │ can: 0,
│ │ │ │ caption: 0,
│ │ │ │ captur: 0,
│ │ │ │ carefulli: 0,
│ │ │ │ caus: 0,