=================
sphinx-packaging
=================
.. start short_desc
**A collection of Sphinx utilities related to Python packaging.**
.. 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-packaging/latest?logo=read-the-docs
:target: https://sphinx-packaging.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/Docs%20Check/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/Linux/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/Windows/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/macOS/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/Flake8/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/mypy/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-packaging/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-packaging/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-packaging/master?logo=coveralls
:target: https://coveralls.io/github/sphinx-toolbox/sphinx-packaging?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-packaging?logo=codefactor
:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-packaging
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-packaging
:target: https://pypi.org/project/sphinx-packaging/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-packaging?logo=python&logoColor=white
:target: https://pypi.org/project/sphinx-packaging/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-packaging
:target: https://pypi.org/project/sphinx-packaging/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-packaging
:target: https://pypi.org/project/sphinx-packaging/
:alt: PyPI - Wheel
.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-packaging
:target: https://github.com/sphinx-toolbox/sphinx-packaging/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-packaging
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-packaging/v0.3.0.post1
:target: https://github.com/sphinx-toolbox/sphinx-packaging/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-packaging
:target: https://github.com/sphinx-toolbox/sphinx-packaging/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2025
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-packaging
:target: https://pypi.org/project/sphinx-packaging/
:alt: PyPI - Downloads
.. end shields
Installation
--------------
.. start installation
``sphinx-packaging`` can be installed from PyPI.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install sphinx-packaging
.. end installation
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-toolbox/sphinx-packaging",
"name": "sphinx-packaging",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "documentation, packaging, pep, sphinx, sphinx-extension, toml",
"author": null,
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/8c/0f/c3129be56dd0bbeb0d5fd674ea2cf27dcb0583d20f068f58eb4e740ff0f0/sphinx_packaging-0.3.0.post1.tar.gz",
"platform": "Windows",
"description": "\n=================\nsphinx-packaging\n=================\n\n.. start short_desc\n\n**A collection of Sphinx utilities related to Python packaging.**\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-packaging/latest?logo=read-the-docs\n\t:target: https://sphinx-packaging.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-packaging/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-packaging/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-packaging/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-packaging/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-packaging/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-packaging/master?logo=coveralls\n\t:target: https://coveralls.io/github/sphinx-toolbox/sphinx-packaging?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-packaging?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-packaging\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-packaging\n\t:target: https://pypi.org/project/sphinx-packaging/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-packaging?logo=python&logoColor=white\n\t:target: https://pypi.org/project/sphinx-packaging/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-packaging\n\t:target: https://pypi.org/project/sphinx-packaging/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-packaging\n\t:target: https://pypi.org/project/sphinx-packaging/\n\t:alt: PyPI - Wheel\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-packaging\n\t:target: https://github.com/sphinx-toolbox/sphinx-packaging/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-packaging\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-packaging/v0.3.0.post1\n\t:target: https://github.com/sphinx-toolbox/sphinx-packaging/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-packaging\n\t:target: https://github.com/sphinx-toolbox/sphinx-packaging/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2025\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-packaging\n\t:target: https://pypi.org/project/sphinx-packaging/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nInstallation\n--------------\n\n.. start installation\n\n``sphinx-packaging`` can be installed from PyPI.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install sphinx-packaging\n\n.. end installation\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A collection of Sphinx utilities related to Python packaging.",
"version": "0.3.0.post1",
"project_urls": {
"Documentation": "https://sphinx-packaging.readthedocs.io/en/latest",
"Homepage": "https://github.com/sphinx-toolbox/sphinx-packaging",
"Issue Tracker": "https://github.com/sphinx-toolbox/sphinx-packaging/issues",
"Source Code": "https://github.com/sphinx-toolbox/sphinx-packaging"
},
"split_keywords": [
"documentation",
" packaging",
" pep",
" sphinx",
" sphinx-extension",
" toml"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1c739c0f155e90b3d70987955a90ce84f927338fafa8df3d0bf8d2bfced72ee7",
"md5": "b056f838c017a4c1e4b233016aba9cf1",
"sha256": "96d83fc370a463dc03f1b13649adc12a38f09bc5f384b87c81d887d3e80fc507"
},
"downloads": -1,
"filename": "sphinx_packaging-0.3.0.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b056f838c017a4c1e4b233016aba9cf1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13613,
"upload_time": "2025-08-04T12:38:28",
"upload_time_iso_8601": "2025-08-04T12:38:28.360256Z",
"url": "https://files.pythonhosted.org/packages/1c/73/9c0f155e90b3d70987955a90ce84f927338fafa8df3d0bf8d2bfced72ee7/sphinx_packaging-0.3.0.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8c0fc3129be56dd0bbeb0d5fd674ea2cf27dcb0583d20f068f58eb4e740ff0f0",
"md5": "6922695d394dc727d7e0da5460336caf",
"sha256": "48f19959ca983b6c786f73749816b2cdae722568924e017ca3d726bb2cf30f76"
},
"downloads": -1,
"filename": "sphinx_packaging-0.3.0.post1.tar.gz",
"has_sig": false,
"md5_digest": "6922695d394dc727d7e0da5460336caf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9548,
"upload_time": "2025-08-04T12:38:29",
"upload_time_iso_8601": "2025-08-04T12:38:29.261794Z",
"url": "https://files.pythonhosted.org/packages/8c/0f/c3129be56dd0bbeb0d5fd674ea2cf27dcb0583d20f068f58eb4e740ff0f0/sphinx_packaging-0.3.0.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-04 12:38:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-toolbox",
"github_project": "sphinx-packaging",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "docutils",
"specs": [
[
">=",
"0.16"
]
]
},
{
"name": "domdf-python-tools",
"specs": [
[
">=",
"3.0.0"
]
]
},
{
"name": "sphinx",
"specs": [
[
">=",
"3.0.3"
]
]
},
{
"name": "sphinx-jinja2-compat",
"specs": [
[
">=",
"0.1.2"
]
]
}
],
"tox": true,
"lcname": "sphinx-packaging"
}
JSON
