sphinx-licenseinfo


Namesphinx-licenseinfo JSON
Version 0.4.0 PyPI version JSON
download
home_pagehttps://github.com/sphinx-toolbox/sphinx-licenseinfo
SummarySphinx directives for showing license information.
upload_time2023-08-01 22:22:37
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT
keywords documentation license sphinx sphinx-extension
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
===================
sphinx-licenseinfo
===================

.. start short_desc

**Sphinx directives for showing license information.**

.. end short_desc


.. start shields

.. list-table::
	:stub-columns: 1
	:widths: 10 90

	* - Docs
	  - |docs| |docs_check|
	* - Tests
	  - |actions_linux| |actions_windows| |actions_macos| |coveralls|
	* - PyPI
	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
	* - Activity
	  - |commits-latest| |commits-since| |maintained| |pypi-downloads|
	* - QA
	  - |codefactor| |actions_flake8| |actions_mypy|
	* - Other
	  - |license| |language| |requires|

.. |docs| image:: https://img.shields.io/readthedocs/sphinx-licenseinfo/latest?logo=read-the-docs
	:target: https://sphinx-licenseinfo.readthedocs.io/en/latest
	:alt: Documentation Build Status

.. |docs_check| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/Docs%20Check/badge.svg
	:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22Docs+Check%22
	:alt: Docs Check Status

.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/Linux/badge.svg
	:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22Linux%22
	:alt: Linux Test Status

.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/Windows/badge.svg
	:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22Windows%22
	:alt: Windows Test Status

.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/macOS/badge.svg
	:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22macOS%22
	:alt: macOS Test Status

.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/Flake8/badge.svg
	:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22Flake8%22
	:alt: Flake8 Status

.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/mypy/badge.svg
	:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22mypy%22
	:alt: mypy status

.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-licenseinfo/badge.svg
	:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-licenseinfo/
	:alt: Requirements Status

.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-licenseinfo/master?logo=coveralls
	:target: https://coveralls.io/github/sphinx-toolbox/sphinx-licenseinfo?branch=master
	:alt: Coverage

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-licenseinfo?logo=codefactor
	:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-licenseinfo
	:alt: CodeFactor Grade

.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-licenseinfo
	:target: https://pypi.org/project/sphinx-licenseinfo/
	:alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-licenseinfo?logo=python&logoColor=white
	:target: https://pypi.org/project/sphinx-licenseinfo/
	:alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-licenseinfo
	:target: https://pypi.org/project/sphinx-licenseinfo/
	:alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-licenseinfo
	:target: https://pypi.org/project/sphinx-licenseinfo/
	:alt: PyPI - Wheel

.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-licenseinfo
	:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/blob/master/LICENSE
	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-licenseinfo
	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-licenseinfo/v0.4.0
	:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/pulse
	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-licenseinfo
	:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/commit/master
	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
	:alt: Maintenance

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-licenseinfo
	:target: https://pypi.org/project/sphinx-licenseinfo/
	:alt: PyPI - Downloads

.. end shields

Installation
--------------

.. start installation

``sphinx-licenseinfo`` can be installed from PyPI.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install sphinx-licenseinfo

.. end installation

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sphinx-toolbox/sphinx-licenseinfo",
    "name": "sphinx-licenseinfo",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "documentation,license,sphinx,sphinx-extension",
    "author": "",
    "author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
    "download_url": "https://files.pythonhosted.org/packages/d2/7d/d24635b2614e6b819ead22384d688a2fd37c33577ab9181437cc51c03cb3/sphinx_licenseinfo-0.4.0.tar.gz",
    "platform": "Windows",
    "description": "\n===================\nsphinx-licenseinfo\n===================\n\n.. start short_desc\n\n**Sphinx directives for showing license information.**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t  - |docs| |docs_check|\n\t* - Tests\n\t  - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t  - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Activity\n\t  - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t  - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t  - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/sphinx-licenseinfo/latest?logo=read-the-docs\n\t:target: https://sphinx-licenseinfo.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-licenseinfo/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-licenseinfo/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-licenseinfo/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-licenseinfo/master?logo=coveralls\n\t:target: https://coveralls.io/github/sphinx-toolbox/sphinx-licenseinfo?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-licenseinfo?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-licenseinfo\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-licenseinfo\n\t:target: https://pypi.org/project/sphinx-licenseinfo/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-licenseinfo?logo=python&logoColor=white\n\t:target: https://pypi.org/project/sphinx-licenseinfo/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-licenseinfo\n\t:target: https://pypi.org/project/sphinx-licenseinfo/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-licenseinfo\n\t:target: https://pypi.org/project/sphinx-licenseinfo/\n\t:alt: PyPI - Wheel\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-licenseinfo\n\t:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-licenseinfo\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-licenseinfo/v0.4.0\n\t:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-licenseinfo\n\t:target: https://github.com/sphinx-toolbox/sphinx-licenseinfo/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2023\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-licenseinfo\n\t:target: https://pypi.org/project/sphinx-licenseinfo/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nInstallation\n--------------\n\n.. start installation\n\n``sphinx-licenseinfo`` can be installed from PyPI.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install sphinx-licenseinfo\n\n.. end installation\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Sphinx directives for showing license information.",
    "version": "0.4.0",
    "project_urls": {
        "Documentation": "https://sphinx-licenseinfo.readthedocs.io/en/latest",
        "Homepage": "https://github.com/sphinx-toolbox/sphinx-licenseinfo",
        "Issue Tracker": "https://github.com/sphinx-toolbox/sphinx-licenseinfo/issues",
        "Source Code": "https://github.com/sphinx-toolbox/sphinx-licenseinfo"
    },
    "split_keywords": [
        "documentation",
        "license",
        "sphinx",
        "sphinx-extension"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b2b148415b7d9d4d6ed33d9ee12ad571a6a805abc569d5fb490382e32cb6fff1",
                "md5": "b6fd96c0ff4290236da5d081b8eefd4a",
                "sha256": "5b32dd2d048bfd98c993c7f034af846a52beeab664566273f1bbb657d76d4719"
            },
            "downloads": -1,
            "filename": "sphinx_licenseinfo-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b6fd96c0ff4290236da5d081b8eefd4a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 34819,
            "upload_time": "2023-08-01T22:22:36",
            "upload_time_iso_8601": "2023-08-01T22:22:36.257285Z",
            "url": "https://files.pythonhosted.org/packages/b2/b1/48415b7d9d4d6ed33d9ee12ad571a6a805abc569d5fb490382e32cb6fff1/sphinx_licenseinfo-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d27dd24635b2614e6b819ead22384d688a2fd37c33577ab9181437cc51c03cb3",
                "md5": "69d80224ed398c3f1c1065cd353e29dd",
                "sha256": "66feec657e2742d04be5c0d50fc8f5657db1c4a96dd76a69fa1e4f8805c7b3aa"
            },
            "downloads": -1,
            "filename": "sphinx_licenseinfo-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "69d80224ed398c3f1c1065cd353e29dd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 11907,
            "upload_time": "2023-08-01T22:22:37",
            "upload_time_iso_8601": "2023-08-01T22:22:37.765656Z",
            "url": "https://files.pythonhosted.org/packages/d2/7d/d24635b2614e6b819ead22384d688a2fd37c33577ab9181437cc51c03cb3/sphinx_licenseinfo-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-01 22:22:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sphinx-toolbox",
    "github_project": "sphinx-licenseinfo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "sphinx-licenseinfo"
}
        
Elapsed time: 0.10107s