sphinxcontrib-packages


Namesphinxcontrib-packages JSON
Version 1.1.2 PyPI version JSON
download
home_pagehttps://framagit.org/spalax/sphinxcontrib-packages
SummaryThis packages contains the Packages sphinx extension, which provides directives to display packages installed on the host machine
upload_time2023-04-26 18:51:51
maintainer
docs_urlNone
authorLouis Paternault
requires_python<4,>=3.7
licenseAGPLv3 or any later version
keywords sphinx package system
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            `sphinxcontrib-packages` 📦 Display a list of tools available on the host machine
=================================================================================

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 developing 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
(and the `Dockerfile <https://hub.docker.com/r/readthedocs/build/~/dockerfile>`__ is not precise enough).

What's new?
-----------

See `changelog <https://git.framasoft.org/spalax/sphinxcontrib-packages/blob/main/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

            

Raw data

            {
    "_id": null,
    "home_page": "https://framagit.org/spalax/sphinxcontrib-packages",
    "name": "sphinxcontrib-packages",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<4,>=3.7",
    "maintainer_email": "",
    "keywords": "sphinx package system",
    "author": "Louis Paternault",
    "author_email": "spalax@gresille.org",
    "download_url": "https://files.pythonhosted.org/packages/50/2c/7936ca9be00f4c9cc86c0b4e86ee7f6c8029f58d0ca9d68cb5f496932c34/sphinxcontrib-packages-1.1.2.tar.gz",
    "platform": null,
    "description": "`sphinxcontrib-packages` \ud83d\udce6 Display a list of tools available on the host machine\n=================================================================================\n\nThis `sphinx <http://sphinx.pocoo.org/>`__ extension provides some directives\nto see what tools are available on the compiling machine. I wrote this because\nI was developing a sphinx extension calling system commands, and I wanted to\nbe able to use is on `readthedocs <http://readthedocs.io>`__, but I did not\nknow which tools were available there\n(and the `Dockerfile <https://hub.docker.com/r/readthedocs/build/~/dockerfile>`__ is not precise enough).\n\nWhat's new?\n-----------\n\nSee `changelog <https://git.framasoft.org/spalax/sphinxcontrib-packages/blob/main/CHANGELOG.md>`_.\n\nInstall\n-------\n\nThis module is compatible with python 3 only.\n\nSee the end of list for a (quick and dirty) Debian package.\n\n* From sources:\n\n  * Download: https://pypi.python.org/pypi/sphinxcontrib-packages\n  * Install (in a `virtualenv`, if you do not want to mess with your distribution installation system)::\n\n      python setup.py install\n\n* From pip::\n\n    pip install sphinxcontrib-packages\n\n* Quick and dirty Debian (and Ubuntu?) package\n\n  This requires `stdeb <https://github.com/astraw/stdeb>`_ to be installed::\n\n      python setup.py --command-packages=stdeb.command bdist_deb\n      sudo dpkg -i deb_dist/python3-sphinxcontrib-packages-<VERSION>_all.deb\n\nDocumentation\n-------------\n\nThe documentation is available on `readthedocs <http://packages.readthedocs.io>`_.  You can build it using::\n\n  cd doc && make html\n",
    "bugtrack_url": null,
    "license": "AGPLv3 or any later version",
    "summary": "This packages contains the Packages sphinx extension, which provides directives to display packages installed on the host machine",
    "version": "1.1.2",
    "split_keywords": [
        "sphinx",
        "package",
        "system"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c08329de3415e2d8a7a49cfe56302dc4f0b7e9c70fadf5781e7426c868050494",
                "md5": "1c0a76583ecc5addb283d6b04d0ab1df",
                "sha256": "5f50dbe0726915efcae137323a1adab188e61b513f8be15370f72f9565691363"
            },
            "downloads": -1,
            "filename": "sphinxcontrib_packages-1.1.2-py3-none-any.whl",
            "has_sig": true,
            "md5_digest": "1c0a76583ecc5addb283d6b04d0ab1df",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.7",
            "size": 19414,
            "upload_time": "2023-04-26T18:51:49",
            "upload_time_iso_8601": "2023-04-26T18:51:49.291360Z",
            "url": "https://files.pythonhosted.org/packages/c0/83/29de3415e2d8a7a49cfe56302dc4f0b7e9c70fadf5781e7426c868050494/sphinxcontrib_packages-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "502c7936ca9be00f4c9cc86c0b4e86ee7f6c8029f58d0ca9d68cb5f496932c34",
                "md5": "2ecc1d5a8d20b6c4aa0f7226e5bc6524",
                "sha256": "ea67f1d817b49d45213d8ad7b2658a19d9ee702a8ac5b2e5b08b57583c735d84"
            },
            "downloads": -1,
            "filename": "sphinxcontrib-packages-1.1.2.tar.gz",
            "has_sig": true,
            "md5_digest": "2ecc1d5a8d20b6c4aa0f7226e5bc6524",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.7",
            "size": 20338,
            "upload_time": "2023-04-26T18:51:51",
            "upload_time_iso_8601": "2023-04-26T18:51:51.655609Z",
            "url": "https://files.pythonhosted.org/packages/50/2c/7936ca9be00f4c9cc86c0b4e86ee7f6c8029f58d0ca9d68cb5f496932c34/sphinxcontrib-packages-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-26 18:51:51",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "sphinxcontrib-packages"
}
        
Elapsed time: 0.09236s