sphinxcontrib-packages


Namesphinxcontrib-packages JSON
Version 1.2.0 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_time2024-12-26 23:19:40
maintainerNone
docs_urlNone
authorLouis Paternault
requires_python<4,>=3.8
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": null,
    "docs_url": null,
    "requires_python": "<4,>=3.8",
    "maintainer_email": null,
    "keywords": "sphinx package system",
    "author": "Louis Paternault",
    "author_email": "spalax@gresille.org",
    "download_url": "https://files.pythonhosted.org/packages/3a/4d/9f32abbfbd2ea1ab29c5199819d2114f7c6ba09d2e45faaaf26777d1ab54/sphinxcontrib_packages-1.2.0.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.2.0",
    "project_urls": {
        "Documentation": "http://packages.readthedocs.io",
        "Homepage": "https://framagit.org/spalax/sphinxcontrib-packages",
        "Source": "https://framagit.org/spalax/sphinxcontrib-packages",
        "Tracker": "https://framagit.org/spalax/sphinxcontrib-packages/issues"
    },
    "split_keywords": [
        "sphinx",
        "package",
        "system"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0ae33c649a43cf62e4de7ba9872f4191c1c13ade3a21af30c8bfb1db0977c1dc",
                "md5": "9fa35f48dad13621242a4b95543a5ea3",
                "sha256": "ea10b144406c51db0a5e1ad40799f037822c25b1d83318971fdb35e81cf8f611"
            },
            "downloads": -1,
            "filename": "sphinxcontrib_packages-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9fa35f48dad13621242a4b95543a5ea3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.8",
            "size": 19411,
            "upload_time": "2024-12-26T23:19:38",
            "upload_time_iso_8601": "2024-12-26T23:19:38.198435Z",
            "url": "https://files.pythonhosted.org/packages/0a/e3/3c649a43cf62e4de7ba9872f4191c1c13ade3a21af30c8bfb1db0977c1dc/sphinxcontrib_packages-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3a4d9f32abbfbd2ea1ab29c5199819d2114f7c6ba09d2e45faaaf26777d1ab54",
                "md5": "fd25aa6d0009756405f9097d05435338",
                "sha256": "bdb5f4b0f4b78491287fdbeeef25fb2e546b1165c94d2ca2a1ec1d27ef11a6a8"
            },
            "downloads": -1,
            "filename": "sphinxcontrib_packages-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fd25aa6d0009756405f9097d05435338",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.8",
            "size": 20385,
            "upload_time": "2024-12-26T23:19:40",
            "upload_time_iso_8601": "2024-12-26T23:19:40.684290Z",
            "url": "https://files.pythonhosted.org/packages/3a/4d/9f32abbfbd2ea1ab29c5199819d2114f7c6ba09d2e45faaaf26777d1ab54/sphinxcontrib_packages-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-26 23:19:40",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "sphinxcontrib-packages"
}
        
Elapsed time: 0.74259s