https://github.com/sphinx-contrib/packages

📦 Provide directives to display packages installed on the host machine.
https://github.com/sphinx-contrib/packages

packages readthedocs sphinx sphinx-extension

Last synced: 7 days ago
JSON representation

📦 Provide directives to display packages installed on the host machine.

• Host: GitHub
• URL: https://github.com/sphinx-contrib/packages
• Owner: sphinx-contrib
• License: agpl-3.0
• Created: 2018-10-30T10:08:12.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-12-26T23:22:58.000Z (4 months ago)
• Last Synced: 2025-04-07T15:01:32.400Z (about 1 month ago)
• Topics: packages, readthedocs, sphinx, sphinx-extension
• Language: Python
• Homepage: https://framagit.org/spalax/sphinxcontrib-packages
• Size: 156 KB
• Stars: 2
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
`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:

  * Download: https://pypi.python.org/pypi/sphinxcontrib-packages

  * Install (in a `virtualenv`, if you do not want to mess with your distribution installation system)::

      python setup.py install

* 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-_all.deb

Documentation

-------------

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

  cd doc && make html