Welcome to the sphinxcontrib-packages documentation

This sphinx extension provides some directives to see what tools are available on the compiling machine. I wrote this because I was developing a sphinx extension calling system commands, and I wanted to be able to use is on readthedocs, but I did not know which tools were available there (and the Dockerfile is not precise enough).

Warning

If your are reading this on readthedocs, keep in mind that those lists are not official. It is not guaranteed that those tools will remain available in the future: they only reflects what was available when this documentation was compiled.

I do not know and I have nothing to do with the readthedocs team, so I do not know how they choose what to install.

Warning

This package was written before readthedocs started using Docker. Since you can run commands before compilation and install Debian packages, I am not sure how relevant this package is now.

Installed tools

If you want to see installed tools, the list is here. Else, se below for more information about this package.

Download and install

See the main project page for instructions, and changelog.

Usage

Add sphinxcontrib.packages to the list of sphinx extensions in your config files, and use of the directives provided by this package.