#################
sphinx-debuginfo
#################
.. start short_desc
**A Sphinx extension to include debugging information in the output.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - 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|
.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/Linux/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/Windows/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/macOS/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/Flake8/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/mypy/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-debuginfo/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-debuginfo/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-debuginfo/master?logo=coveralls
:target: https://coveralls.io/github/sphinx-toolbox/sphinx-debuginfo?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-debuginfo?logo=codefactor
:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-debuginfo
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-debuginfo
:target: https://pypi.org/project/sphinx-debuginfo/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-debuginfo?logo=python&logoColor=white
:target: https://pypi.org/project/sphinx-debuginfo/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-debuginfo
:target: https://pypi.org/project/sphinx-debuginfo/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-debuginfo
:target: https://pypi.org/project/sphinx-debuginfo/
:alt: PyPI - Wheel
.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-debuginfo
:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-debuginfo
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-debuginfo/v0.2.2.post1
:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-debuginfo
:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/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-debuginfo
:target: https://pypi.org/project/sphinx-debuginfo/
:alt: PyPI - Downloads
.. end shields
See an example of the output in the documentation for
`sphinx-toolbox <https://sphinx-toolbox.readthedocs.io/en/latest/_debug/>`_.
Installation
--------------
.. start installation
``sphinx-debuginfo`` can be installed from PyPI.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install sphinx-debuginfo
.. end installation
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-toolbox/sphinx-debuginfo",
"name": "sphinx-debuginfo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "debug,sphinx,sphinx-extension",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/bc/3c/a87f2d13a617b6d2bf21ca6ece3c5dfc77a82fc629839e999e0bb93b9d98/sphinx_debuginfo-0.2.2.post1.tar.gz",
"platform": "Windows",
"description": "\n#################\nsphinx-debuginfo\n#################\n\n.. start short_desc\n\n**A Sphinx extension to include debugging information in the output.**\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* - 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.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-debuginfo/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/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-debuginfo/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-debuginfo/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-debuginfo/master?logo=coveralls\n\t:target: https://coveralls.io/github/sphinx-toolbox/sphinx-debuginfo?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-debuginfo?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-debuginfo\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-debuginfo\n\t:target: https://pypi.org/project/sphinx-debuginfo/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-debuginfo?logo=python&logoColor=white\n\t:target: https://pypi.org/project/sphinx-debuginfo/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-debuginfo\n\t:target: https://pypi.org/project/sphinx-debuginfo/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-debuginfo\n\t:target: https://pypi.org/project/sphinx-debuginfo/\n\t:alt: PyPI - Wheel\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-debuginfo\n\t:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-debuginfo\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-debuginfo/v0.2.2.post1\n\t:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-debuginfo\n\t:target: https://github.com/sphinx-toolbox/sphinx-debuginfo/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-debuginfo\n\t:target: https://pypi.org/project/sphinx-debuginfo/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nSee an example of the output in the documentation for\n`sphinx-toolbox <https://sphinx-toolbox.readthedocs.io/en/latest/_debug/>`_.\n\nInstallation\n--------------\n\n.. start installation\n\n``sphinx-debuginfo`` can be installed from PyPI.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install sphinx-debuginfo\n\n.. end installation\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Sphinx extension to include debugging information in the output.",
"version": "0.2.2.post1",
"project_urls": {
"Homepage": "https://github.com/sphinx-toolbox/sphinx-debuginfo",
"Issue Tracker": "https://github.com/sphinx-toolbox/sphinx-debuginfo/issues",
"Source Code": "https://github.com/sphinx-toolbox/sphinx-debuginfo"
},
"split_keywords": [
"debug",
"sphinx",
"sphinx-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd845af563d08cf03cce1de18cb577674a6c1c9a9bfacdda9896807a31537e3b",
"md5": "a7805467244b4d8f9b75b9e2e0d9564a",
"sha256": "92c580f1049b7e6ff7eddc29d4e33802170c73dac16d413238d7a64657d4ac8c"
},
"downloads": -1,
"filename": "sphinx_debuginfo-0.2.2.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7805467244b4d8f9b75b9e2e0d9564a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12218,
"upload_time": "2023-11-22T11:11:48",
"upload_time_iso_8601": "2023-11-22T11:11:48.233895Z",
"url": "https://files.pythonhosted.org/packages/cd/84/5af563d08cf03cce1de18cb577674a6c1c9a9bfacdda9896807a31537e3b/sphinx_debuginfo-0.2.2.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bc3ca87f2d13a617b6d2bf21ca6ece3c5dfc77a82fc629839e999e0bb93b9d98",
"md5": "780e1a64eeec94bcd9ce9b41f723fe83",
"sha256": "48433a73f236e04927d5333afa51bf090e20ea16dded032392a72735c959bd70"
},
"downloads": -1,
"filename": "sphinx_debuginfo-0.2.2.post1.tar.gz",
"has_sig": false,
"md5_digest": "780e1a64eeec94bcd9ce9b41f723fe83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4315,
"upload_time": "2023-11-22T11:11:50",
"upload_time_iso_8601": "2023-11-22T11:11:50.236319Z",
"url": "https://files.pythonhosted.org/packages/bc/3c/a87f2d13a617b6d2bf21ca6ece3c5dfc77a82fc629839e999e0bb93b9d98/sphinx_debuginfo-0.2.2.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 11:11:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-toolbox",
"github_project": "sphinx-debuginfo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "sphinx-debuginfo"
}
JSON
