{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/8"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"},{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"A Sphinx extension that automatically runs sphinx-apidoc during documentation builds, generating API documentation from Python source code without requiring separate build steps.","skillfed_tags":["sphinx-extension","api-documentation","build-automation"],"use_cases":["Simplify documentation builds by moving sphinx-apidoc configuration from tox.ini into conf.py, reducing build orchestration complexity.","Automatically generate API reference documentation for Python packages as part of the standard sphinx-build workflow.","Migrate from pbr's autodoc_tree feature to a standalone Sphinx extension without changing documentation structure.","Exclude test modules and private code from generated API docs using fnmatch-style path patterns."],"what_it_does":"sphinxcontrib-apidoc is a Sphinx extension that integrates sphinx-apidoc into the documentation build process, eliminating the need to run sphinx-apidoc as a separate step before sphinx-build. Instead of configuring API documentation generation in tox.ini or shell scripts, you define settings directly in your Sphinx conf.py file.\n\nThe extension accepts configuration options like apidoc_module_dir (the Python package to document), apidoc_output_dir (where to write generated files), apidoc_excluded_paths (modules to skip), and apidoc_separate_modules (whether each module gets its own page). It depends on pbr and Sphinx, supports Python 3.9+, and is actively maintained. However, the project documentation notes that Sphinx now includes a built-in extension with similar functionality, and existing users are encouraged to migrate to that instead.","worth_installing":"Yes, if you are already using Sphinx and want to simplify your documentation build pipeline by integrating sphinx-apidoc directly into conf.py. However, check whether Sphinx's built-in apidoc extension meets your needs first, as the project documentation recommends new users adopt that instead and notes this project will eventually be retired."},"id":"sphinxcontrib-apidoc","links":{"html":"https://skillfed.io/packages/sphinxcontrib-apidoc","md":"https://skillfed.io/packages/sphinxcontrib-apidoc.md","pypi":"https://pypi.org/project/sphinxcontrib-apidoc/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-05-08","license_spdx":null,"license_treatment":"permissive","name":"sphinxcontrib-apidoc","python_support":"supports_current","summary":"A Sphinx extension for running 'sphinx-apidoc' on each build"},"popularity":{"monthly_downloads":195630,"position":9810,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.6.0"}