{"library":"sphinx-toolbox","title":"Sphinx Toolbox","type":"library","description":"sphinx-toolbox is a collection of handy tools and extensions designed to enhance Sphinx, the Python documentation generator. It provides various directives, roles, advanced autodoc features, and general tweaks to improve the Sphinx documentation experience. The library is currently at version 4.1.2 and maintains an active development cycle, releasing minor and patch versions frequently to support new Sphinx and Python versions.","language":"python","status":"active","last_verified":"Sat May 16","install":{"commands":["pip install sphinx-toolbox"],"cli":{"name":"sphinx-toolbox","version":"sh: 1: sphinx-toolbox: not found"}},"imports":["# In conf.py\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx_toolbox',\n    'sphinx_toolbox.more_autodoc' # Or specific sub-extensions\n]"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/sphinx-toolbox/sphinx-toolbox","docs":"https://sphinx-toolbox.readthedocs.io/en/latest","changelog":null,"pypi":"https://pypi.org/project/sphinx-toolbox/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# conf.py\n\n# Standard Sphinx extensions\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx.ext.napoleon',\n    'sphinx.ext.viewcode',\n]\n\n# Add sphinx-toolbox extensions\nextensions.extend([\n    'sphinx_toolbox', # Enables core toolbox features\n    'sphinx_toolbox.more_autodoc', # Enables all enhanced autodoc features\n    # Or enable specific sub-extensions individually, e.g.:\n    # 'sphinx_toolbox.collapse',\n    # 'sphinx_toolbox.github',\n    # 'sphinx_toolbox.installation',\n])\n\n# Project information\nproject = 'My Project'\ncopyright = '2026, Your Name'\nauthor = 'Your Name'\nrelease = '0.1.0'\n\n# Example of a sphinx-toolbox configuration option\n# source_link_target = 'GitHub' # For sphinx_toolbox.source extension\n","lang":"python","description":"To quickly get started, install the library and then add 'sphinx_toolbox' and any desired sub-extensions (like 'sphinx_toolbox.more_autodoc') to the `extensions` list in your Sphinx project's `conf.py` file. This enables the enhanced features provided by the toolbox.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-16","installed_version":"4.1.2","pypi_latest":"4.1.2","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":7.2,"avg_import_s":null,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"103.4M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":7.1,"import_time_s":null,"mem_mb":null,"disk_size":"105M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"114.2M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":7.4,"import_time_s":null,"mem_mb":null,"disk_size":"116M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"105.0M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":6.7,"import_time_s":null,"mem_mb":null,"disk_size":"107M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"105.1M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":6.6,"import_time_s":null,"mem_mb":null,"disk_size":"107M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"102.4M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"sphinx-toolbox","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":8.2,"import_time_s":null,"mem_mb":null,"disk_size":"104M"}]}}