Metadata-Version: 1.1
Name: sphinxcontrib-packages
Version: 1.0.1
Summary: This packages contains the Packages sphinx extension, which provides directives to display packages installed on the host machine
Home-page: https://git.framasoft.org/spalax/sphinxcontrib-packages
Author: Louis Paternault
Author-email: spalax+python@gresille.org
License: AGPLv3 or any later version
Description-Content-Type: UNKNOWN
Description: `sphinxcontrib-packages` 📦 Display available tools available on the host machine
        =================================================================================
        
        |sources| |pypi| |build| |coverage| |documentation| |license|
        
        This `sphinx <http://sphinx.pocoo.org/>`__ extension provides some directives
        to see what tools are available on the compiling machine. I wrote this because
        I was developping a sphinx extension calling system commands, and I wanted to
        be able to use is on `readthedocs <http://readthedocs.io>`__, but I did not
        know which tools were available there: the `official list of installed tools <https://docs.readthedocs.io/en/latest/builds.html#packages-installed-in-the-build-environment>`__
        is pretty scarce…
        
        What's new?
        -----------
        
        See `changelog <https://git.framasoft.org/spalax/sphinxcontrib-packages/blob/master/CHANGELOG.md>`_.
        
        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 <https://github.com/astraw/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 <http://packages.readthedocs.io>`_.  You can build it using::
        
          cd doc && make html
        
        .. |documentation| image:: http://readthedocs.org/projects/packages/badge
          :target: http://packages.readthedocs.io
        .. |pypi| image:: https://img.shields.io/pypi/v/sphinxcontrib-packages.svg
          :target: http://pypi.python.org/pypi/sphinxcontrib-packages
        .. |license| image:: https://img.shields.io/pypi/l/sphinxcontrib-packages.svg
          :target: http://www.gnu.org/licenses/agpl-3.0.html
        .. |sources| image:: https://img.shields.io/badge/sources-sphinxcontrib--packages-brightgreen.svg
          :target: http://git.framasoft.org/spalax/sphinxcontrib-packages
        .. |coverage| image:: https://framagit.org/spalax/sphinxcontrib-packages/badges/master/coverage.svg
          :target: https://framagit.org/spalax/sphinxcontrib-packages/builds
        .. |build| image:: https://framagit.org/spalax/sphinxcontrib-packages/badges/master/build.svg
          :target: https://framagit.org/spalax/sphinxcontrib-packages/builds
        
Keywords: sphinx packages system
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Libraries :: Python Modules
