sphinx-toolbox 4.0.0


pip install sphinx-toolbox

  Latest version

Released: May 12, 2025


Meta
Author: Dominic Davis-Foster
Requires Python: >=3.7

Classifiers

Development Status
  • 5 - Production/Stable

Framework
  • Sphinx :: Extension

Intended Audience
  • Developers

License
  • OSI Approved :: MIT License

Operating System
  • OS Independent

Programming Language
  • Python
  • Python :: 3 :: Only
  • Python :: 3.7
  • Python :: 3.8
  • Python :: 3.9
  • Python :: 3.10
  • Python :: 3.11
  • Python :: 3.12
  • Python :: 3.13
  • Python :: Implementation :: CPython
  • Python :: Implementation :: PyPy

Topic
  • Documentation
  • Documentation :: Sphinx
  • Software Development :: Documentation
  • Software Development :: Libraries :: Python Modules
  • Utilities

Typing
  • Typed

Box of handy tools for Sphinx ๐Ÿงฐ ๐Ÿ“”

Docs

Documentation Build Status Docs Check Status

Tests

Linux Test Status Windows Test Status macOS Test Status Coverage

PyPI

PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel

Anaconda

Conda - Package Version Conda - Platform

Activity

GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads

QA

CodeFactor Grade Flake8 Status mypy status

Other

License GitHub top language Requirements Status


Installation

sphinx-toolbox can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install sphinx-toolbox

To install with conda:

  • First add the required channels

$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
  • Then install

$ conda install sphinx-toolbox
4.0.0 May 12, 2025
3.10.0 May 06, 2025
3.9.0 Feb 26, 2025
3.8.3 Feb 20, 2025
3.8.2 Feb 07, 2025
3.8.1 Oct 10, 2024
3.8.0 Aug 15, 2024
3.7.0 Jul 04, 2024
3.6.0 Jun 24, 2024
3.5.0 Jul 24, 2023
3.4.0 Jan 23, 2023
3.3.0 Jan 13, 2023
3.2.0 Aug 16, 2022
3.2.0b1 Aug 03, 2022
3.1.2 Jun 28, 2022
3.1.1 Jun 10, 2022
3.1.0 Jun 08, 2022
3.0.0 May 12, 2022
3.0.0a4 May 08, 2022
3.0.0a3 May 03, 2022
3.0.0a2 Apr 28, 2022
3.0.0a1 Apr 21, 2022
2.18.3 May 05, 2022
2.18.2 Apr 21, 2022
2.18.1 Apr 10, 2022
2.18.0 Feb 28, 2022
2.17.0 Feb 09, 2022
2.16.1 Jan 22, 2022
2.16.0 Jan 18, 2022
2.16.0b1 Jan 16, 2022
2.15.3 Jan 11, 2022
2.15.2 Dec 16, 2021
2.15.1 Dec 02, 2021
2.15.0 Sep 28, 2021
2.14.1 Sep 20, 2021
2.14.0 Sep 06, 2021
2.13.0 Jul 14, 2021
2.13.0b3 Jun 20, 2021
2.13.0b2 Jun 18, 2021
2.13.0b1 Jun 18, 2021
2.12.1 Jun 12, 2021
2.12.0 Jun 06, 2021
2.11.2 May 19, 2021
2.11.1 May 18, 2021
2.11.0 May 17, 2021
2.10.1 Jun 16, 2021
2.10.0 May 10, 2021
2.9.0 May 06, 2021
2.8.3 May 05, 2021
2.8.2 May 04, 2021
2.8.1 May 04, 2021
2.8.0 Apr 30, 2021
2.7.0 Apr 27, 2021
2.6.1 Apr 24, 2021
2.6.0 Apr 23, 2021
2.5.1 Apr 22, 2021
2.5.0 Apr 22, 2021
2.4.1 Apr 14, 2021
2.4.0 Apr 14, 2021
2.3.1 Apr 13, 2021
2.3.0 Apr 04, 2021
2.2.0 Mar 21, 2021
2.1.0 Mar 15, 2021
2.0.4 Mar 11, 2021
2.0.3 Mar 10, 2021
2.0.2 Feb 10, 2021
2.0.1 Feb 06, 2021
2.0.0 Jan 18, 2021
1.9.0 Jan 13, 2021
1.8.4 Jan 01, 2021
1.8.3 Dec 26, 2020
1.8.2 Dec 08, 2020
1.8.1 Dec 08, 2020
1.8.0 Nov 30, 2020
1.7.5 Nov 23, 2020
1.7.4 Nov 19, 2020
1.7.3 Nov 19, 2020
1.7.2 Nov 11, 2020
1.7.1 Nov 02, 2020
1.7.0 Oct 28, 2020
1.6.2 Oct 19, 2020
1.6.1 Oct 19, 2020
1.6.0 Oct 19, 2020
1.5.1 Oct 06, 2020
1.5.0 Oct 02, 2020
1.4.1 Oct 01, 2020
1.4.0 Sep 29, 2020
1.3.1 Sep 27, 2020
1.3.0 Sep 27, 2020
1.2.2 Sep 25, 2020
1.2.1 Sep 23, 2020
1.2.0 Sep 22, 2020
1.1.2 Sep 22, 2020
1.1.1 Sep 21, 2020
1.1.0 Sep 21, 2020
1.0.0 Sep 21, 2020
0.9.2 Sep 19, 2020
0.9.1 Sep 18, 2020
0.9.0 Sep 17, 2020
0.8.1 Sep 17, 2020
0.8.0 Sep 16, 2020
0.7.0 Sep 14, 2020
0.6.0 Sep 13, 2020
0.5.1 Sep 11, 2020
0.5.0 Sep 11, 2020
0.4.0 Sep 10, 2020
0.3.3 Sep 09, 2020
0.3.2 Sep 09, 2020
0.3.1 Sep 09, 2020
0.3.0 Sep 09, 2020
0.2.1 Sep 08, 2020
0.2.0 Sep 08, 2020
0.1.1 Sep 08, 2020
0.1.0 Sep 01, 2020

Wheel compatibility matrix

Platform Python 3
any

Files in release

Extras:
Dependencies:
apeye (>=0.4.0)
autodocsumm (>=0.2.0)
beautifulsoup4 (>=4.9.1)
cachecontrol[filecache] (>=0.13.0)
dict2css (>=0.2.3)
docutils (>=0.16)
domdf-python-tools (>=2.9.0)
filelock (>=3.8.0)
html5lib (>=1.1)
ruamel.yaml (>=0.16.12)
sphinx (>=3.2.0)
sphinx-autodoc-typehints (>=1.11.1)
sphinx-jinja2-compat (>=0.1.0)
sphinx-prompt (>=1.1.0)
sphinx-tabs (<3.4.7,>=1.2.1)
tabulate (>=0.8.7)
typing-extensions (!=3.10.0.1,>=3.7.4.3)
typing-inspect (>=0.6.0)