* - 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/conda-forge/sphinx-toolbox?logo=anaconda :target: https://anaconda.org/conda-forge/sphinx-toolbox :alt: Conda - Package Version

.. |conda-platform| image:: https://img.shields.io/conda/pn/conda-forge/sphinx-toolbox?label=conda%7Cplatform :target: https://anaconda.org/conda-forge/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/v4.2.0 :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/2026 :alt: Maintenance

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/sphinx-toolbox :target: https://pypistats.org/packages/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:

.. code-block:: bash

$ conda install -c conda-forge sphinx-toolbox

.. end installation

分类

Development Status :: 5 - Production/Stable Framework :: Sphinx :: Extension Intended Audience :: Developers License :: OSI Approved :: MIT License Operating System :: OS Independent Programming Language :: Python Programming Language :: Python :: 3 :: Only Programming Language :: Python :: 3.10 Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.12 Programming Language :: Python :: 3.13 Programming Language :: Python :: 3.7 Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 Programming Language :: Python :: Implementation :: CPython Programming Language :: Python :: Implementation :: PyPy Topic :: Documentation Topic :: Documentation :: Sphinx Topic :: Software Development :: Documentation Topic :: Software Development :: Libraries :: Python Modules Topic :: Utilities Typing :: Typed

版本列表

4.2.0 2026-05-21

4.2.0rc1 2026-04-24

4.1.2 2026-01-14

4.1.1 2026-01-01

4.1.0 2025-12-05

4.0.0 2025-05-12

3.10.0 2025-05-06

3.9.0 2025-02-26

3.8.3 2025-02-20

3.8.2 2025-02-07

3.8.1 2024-10-10

3.8.0 2024-08-15

3.7.0 2024-07-04

3.6.0 2024-06-24

3.5.0 2023-07-24

3.4.0 2023-01-23

3.3.0 2023-01-13

3.2.0 2022-08-16

3.2.0b1 2022-08-03

3.1.2 2022-06-28

3.1.1 2022-06-10

3.1.0 2022-06-08

3.0.0 2022-05-12

3.0.0a4 2022-05-08

3.0.0a3 2022-05-03

3.0.0a2 2022-04-28

3.0.0a1 2022-04-21

2.18.3 2022-05-05

2.18.2 2022-04-21

2.18.1 2022-04-10

2.18.0 2022-02-28

2.17.0 2022-02-09

2.16.1 2022-01-22

2.16.0 2022-01-18

2.16.0b1 2022-01-16

2.15.3 2022-01-11

2.15.2 2021-12-16

2.15.1 2021-12-02

2.15.0 2021-09-28

2.14.1 2021-09-20

2.14.0 2021-09-06

2.13.0 2021-07-14

2.13.0b3 2021-06-20

2.13.0b2 2021-06-18

2.13.0b1 2021-06-18

2.12.1 2021-06-12

2.12.0 2021-06-06

2.11.2 2021-05-19

2.11.1 2021-05-18

2.11.0 2021-05-17

2.10.1 2021-06-16

2.10.0 2021-05-10

2.9.0 2021-05-06

2.8.3 2021-05-05

2.8.2 2021-05-04

2.8.1 2021-05-04

2.8.0 2021-04-30

2.7.0 2021-04-27

2.6.1 2021-04-24

2.6.0 2021-04-23

2.5.1 2021-04-22

2.5.0 2021-04-22

2.4.1 2021-04-14

2.4.0 2021-04-14

2.3.1 2021-04-13

2.3.0 2021-04-04

2.2.0 2021-03-21

2.1.0 2021-03-15

2.0.4 2021-03-11

2.0.3 2021-03-10

2.0.2 2021-02-10

2.0.1 2021-02-06

2.0.0 2021-01-18

1.9.0 2021-01-13

1.8.4 2021-01-01

1.8.3 2020-12-26

1.8.2 2020-12-08

1.8.1 2020-12-08

1.8.0 2020-11-30

1.7.5 2020-11-23

1.7.4 2020-11-19

1.7.3 2020-11-19

1.7.2 2020-11-11

1.7.1 2020-11-02

1.7.0 2020-10-28

1.6.2 2020-10-19

1.6.1 2020-10-19

1.6.0 2020-10-19

1.5.1 2020-10-06

1.5.0 2020-10-02

1.4.1 2020-10-01

1.4.0 2020-09-29

1.3.1 2020-09-27

1.3.0 2020-09-27

1.2.2 2020-09-25

1.2.1 2020-09-23

1.2.0 2020-09-22

1.1.2 2020-09-22

1.1.1 2020-09-21

1.1.0 2020-09-21

1.0.0 2020-09-21

0.9.2 2020-09-19

0.9.1 2020-09-18

0.9.0 2020-09-17

0.8.1 2020-09-17

0.8.0 2020-09-16

0.7.0 2020-09-14

0.6.0 2020-09-13

0.5.1 2020-09-11

0.5.0 2020-09-11

0.4.0 2020-09-10

0.3.3 2020-09-09

0.3.2 2020-09-09

0.3.1 2020-09-09

0.3.0 2020-09-09

0.2.1 2020-09-08

0.2.0 2020-09-08

0.1.1 2020-09-08

0.1.0 2020-09-01