Skip to content

sphinx-contrib/packages

Repository files navigation

sphinxcontrib-packages 📦 Display a list of tools available on the host machine

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).

What's new?

See changelog.

Install

This module is compatible with python 3 only.

See the end of list for a (quick and dirty) Debian package.

  • From sources:
  • From pip:

    pip install sphinxcontrib-packages
  • Quick and dirty Debian (and Ubuntu?) package

    This requires stdeb to be installed:

    python setup.py --command-packages=stdeb.command bdist_deb
    sudo dpkg -i deb_dist/python3-sphinxcontrib-packages-<VERSION>_all.deb

Documentation

The documentation is available on readthedocs. You can build it using:

cd doc && make html