Starting withe 2021, release notes are accessed from: https://github.com/sphinx-contrib/sphinxcontrib-programoutput/releases
- Add
name
andcaption
options. Added in PR 41 by Raphaël. - Add support for Python 3.8.
- Make the test suite stop assuming the presence of a 'python' executable on the path. Instead it uses
sys.executable
(which shouldn't have spaces). Note that it does continue to assume the presence of other executables, such as 'echo'. Reported in issue 38 by John Vandenberg.
- Add
python_requires
metadata to better allow tools likepip
to install a correct version. - Add support for Sphinx 2.0 on Python 3.
- Avoid unicode errors when the program command or output produced non-ASCII output and the configured prompt was a byte string. This was most likely under Python 2, where the default configured prompt is a byte string. Reported by, and patch inspired by, issue 33 by latricewilgus.
- Drop support for Sphinx < 1.7.
- Fix tests on Sphinx >= 1.8.0.
- Restore error message into the document by default from failed program runs on Sphinx >= 1.8.0b1.
- Fix deprecation warnings on Sphinx >= 1.8. Reported in issue 29 by miili.
- Explicitly set
parallel_read_safe
to true in the extension metadata. See issue 25. With thanks to Adam J. Stewart and Stephen McDowell.
- Decode output from the program tolerantly, using the 'replace' handler. Based on a pull request by Stefan C. Müller.
- Forked and revived the project in Gitub.
- Run the tests on Travis CI. Formatting and style is enforced by pylint.
- The oldest supported and tested Sphinx version is now 1.3.5. See issue 17.
- Remove support for Python 2.6, Python 3.2 and 3.3.
- 100% test coverage.
- Remove support for
programoutput_use_ansi
. Thesphinxcontrib.ansi
extension is no longer available on PyPI.
- Migrated to GitHub
- Added
cwd
option to..program-output
- Working directory of executed programs defaults to documentation root now
- Python 3 support
- Require Sphinx 1.1 now
programoutput_prompt_template
is interpreted as format string now!- Require Python 2.6 now
- Added
returncode
option toprogram-output
(thanks to Jan-Marek Glogowski) - Support
returncode
formatting key inprogramoutput_prompt_template
- Warn on unexpected return codes instead of raising
subprocess.CalledProcessError
- Turn fatal errors during command into document error messages instead of crashing the build
- Some source code cleanups
- Fixed installation instructions in documentation
- Initial release