###############
sphinx-toolbox
###############
.. start short_desc
**Box of handy tools for Sphinx 🧰 📔**
.. 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|
* - Anaconda
- |conda-version| |conda-platform|
* - 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-toolbox/latest?logo=read-the-docs
:target: https://sphinx-toolbox.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/Docs%20Check/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/Linux/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/Windows/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/macOS/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/Flake8/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/mypy/badge.svg
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-toolbox/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-toolbox/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-toolbox/master?logo=coveralls
:target: https://coveralls.io/github/sphinx-toolbox/sphinx-toolbox?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-toolbox?logo=codefactor
:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-toolbox
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-toolbox
:target: https://pypi.org/project/sphinx-toolbox/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-toolbox?logo=python&logoColor=white
:target: https://pypi.org/project/sphinx-toolbox/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-toolbox
:target: https://pypi.org/project/sphinx-toolbox/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-toolbox
:target: https://pypi.org/project/sphinx-toolbox/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/sphinx-toolbox?logo=anaconda
:target: https://anaconda.org/domdfcoding/sphinx-toolbox
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/sphinx-toolbox?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/sphinx-toolbox
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-toolbox
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-toolbox
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-toolbox/v3.8.1
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-toolbox
:target: https://github.com/sphinx-toolbox/sphinx-toolbox/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-toolbox
:target: https://pypi.org/project/sphinx-toolbox/
:alt: PyPI - Downloads
.. end shields
|
Installation
--------------
.. start installation
``sphinx-toolbox`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install sphinx-toolbox
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install sphinx-toolbox
.. end installation
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-toolbox/sphinx-toolbox",
"name": "sphinx-toolbox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "documentation, sphinx, sphinx-extension",
"author": null,
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/30/80/f837e85c8c216cdeef9b60393e4b00c9092a1e3d734106e0021abbf5930c/sphinx_toolbox-3.8.1.tar.gz",
"platform": "Windows",
"description": "\n###############\nsphinx-toolbox\n###############\n\n.. start short_desc\n\n**Box of handy tools for Sphinx \ud83e\uddf0 \ud83d\udcd4**\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* - Anaconda\n\t - |conda-version| |conda-platform|\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-toolbox/latest?logo=read-the-docs\n\t:target: https://sphinx-toolbox.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-toolbox/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/sphinx-toolbox/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/sphinx-toolbox/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-toolbox/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/sphinx-toolbox/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/sphinx-toolbox/master?logo=coveralls\n\t:target: https://coveralls.io/github/sphinx-toolbox/sphinx-toolbox?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/sphinx-toolbox?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/sphinx-toolbox\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-toolbox\n\t:target: https://pypi.org/project/sphinx-toolbox/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-toolbox?logo=python&logoColor=white\n\t:target: https://pypi.org/project/sphinx-toolbox/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-toolbox\n\t:target: https://pypi.org/project/sphinx-toolbox/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-toolbox\n\t:target: https://pypi.org/project/sphinx-toolbox/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/sphinx-toolbox?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/sphinx-toolbox\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/sphinx-toolbox?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/sphinx-toolbox\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/sphinx-toolbox\n\t:target: https://github.com/sphinx-toolbox/sphinx-toolbox/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/sphinx-toolbox\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/sphinx-toolbox/v3.8.1\n\t:target: https://github.com/sphinx-toolbox/sphinx-toolbox/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/sphinx-toolbox\n\t:target: https://github.com/sphinx-toolbox/sphinx-toolbox/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2024\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-toolbox\n\t:target: https://pypi.org/project/sphinx-toolbox/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\n|\n\nInstallation\n--------------\n\n.. start installation\n\n``sphinx-toolbox`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install sphinx-toolbox\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install sphinx-toolbox\n\n.. end installation\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Box of handy tools for Sphinx \ud83e\uddf0 \ud83d\udcd4",
"version": "3.8.1",
"project_urls": {
"Documentation": "https://sphinx-toolbox.readthedocs.io/en/latest",
"Homepage": "https://github.com/sphinx-toolbox/sphinx-toolbox",
"Issue Tracker": "https://github.com/sphinx-toolbox/sphinx-toolbox/issues",
"Source Code": "https://github.com/sphinx-toolbox/sphinx-toolbox"
},
"split_keywords": [
"documentation",
" sphinx",
" sphinx-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8ad62a28ee4cbc158ae65afb2cfcb6895ef54d972ce1e167f8a63c135b14b080",
"md5": "f3f7844922e1912de0f2d68acbf64328",
"sha256": "53d8e77dd79e807d9ef18590c4b2960a5aa3c147415054b04c31a91afed8b88b"
},
"downloads": -1,
"filename": "sphinx_toolbox-3.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f3f7844922e1912de0f2d68acbf64328",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 194621,
"upload_time": "2024-10-10T11:18:32",
"upload_time_iso_8601": "2024-10-10T11:18:32.707096Z",
"url": "https://files.pythonhosted.org/packages/8a/d6/2a28ee4cbc158ae65afb2cfcb6895ef54d972ce1e167f8a63c135b14b080/sphinx_toolbox-3.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3080f837e85c8c216cdeef9b60393e4b00c9092a1e3d734106e0021abbf5930c",
"md5": "ee5fdb69bb85520f4ca9371b3833c9db",
"sha256": "a4b39a6ea24fc8f10e24f052199bda17837a0bf4c54163a56f521552395f5e1a"
},
"downloads": -1,
"filename": "sphinx_toolbox-3.8.1.tar.gz",
"has_sig": false,
"md5_digest": "ee5fdb69bb85520f4ca9371b3833c9db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 111977,
"upload_time": "2024-10-10T11:18:34",
"upload_time_iso_8601": "2024-10-10T11:18:34.356808Z",
"url": "https://files.pythonhosted.org/packages/30/80/f837e85c8c216cdeef9b60393e4b00c9092a1e3d734106e0021abbf5930c/sphinx_toolbox-3.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 11:18:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-toolbox",
"github_project": "sphinx-toolbox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "apeye",
"specs": [
[
">=",
"0.4.0"
]
]
},
{
"name": "autodocsumm",
"specs": [
[
">=",
"0.2.0"
]
]
},
{
"name": "beautifulsoup4",
"specs": [
[
">=",
"4.9.1"
]
]
},
{
"name": "cachecontrol",
"specs": [
[
">=",
"0.13.0"
]
]
},
{
"name": "dict2css",
"specs": [
[
">=",
"0.2.3"
]
]
},
{
"name": "docutils",
"specs": [
[
">=",
"0.16"
]
]
},
{
"name": "domdf-python-tools",
"specs": [
[
">=",
"2.9.0"
]
]
},
{
"name": "filelock",
"specs": [
[
">=",
"3.8.0"
]
]
},
{
"name": "html5lib",
"specs": [
[
">=",
"1.1"
]
]
},
{
"name": "ruamel.yaml",
"specs": [
[
">=",
"0.16.12"
]
]
},
{
"name": "sphinx",
"specs": [
[
">=",
"3.2.0"
]
]
},
{
"name": "sphinx-autodoc-typehints",
"specs": [
[
">=",
"1.11.1"
]
]
},
{
"name": "sphinx-jinja2-compat",
"specs": [
[
">=",
"0.1.0"
]
]
},
{
"name": "sphinx-prompt",
"specs": [
[
">=",
"1.1.0"
]
]
},
{
"name": "sphinx-tabs",
"specs": [
[
">=",
"1.2.1"
],
[
"<",
"3.4.7"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.8.7"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"!=",
"3.10.0.1"
],
[
">=",
"3.7.4.3"
]
]
},
{
"name": "typing-inspect",
"specs": [
[
">=",
"0.6.0"
]
]
}
],
"tox": true,
"lcname": "sphinx-toolbox"
}
JSON
