{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"},{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Sphinx extension that renders OpenAPI (Swagger) specifications into formatted API documentation using the HTTP domain.","skillfed_tags":["api-documentation","openapi","sphinx-extension"],"use_cases":["Generate API reference documentation from an OpenAPI spec as part of your Sphinx build process.","Keep API docs automatically synchronized with your OpenAPI definition during development.","Render REST endpoint details (paths, methods, parameters, responses) into a Sphinx project.","Embed interactive or formatted API specifications into larger technical documentation.","Build a single-source documentation site where API reference comes from your spec file."],"what_it_does":"sphinxcontrib-openapi is a Sphinx extension that converts OpenAPI (formerly Swagger) specification files into formatted API documentation. It leverages the sphinxcontrib-httpdomain extension to provide HTTP domain support, so it integrates naturally with Sphinx's documentation build pipeline. You add it to your Sphinx conf.py extensions list and then use the openapi directive to point to your spec file\u2014typically a YAML or JSON OpenAPI definition\u2014and it renders the endpoints, parameters, request/response schemas, and other API details into your documentation.\n\nThe package depends on Sphinx, PyYAML for parsing specs, jsonschema for validation, and a few utility libraries (picobox, deepmerge, sphinx-mdinclude) to handle configuration and schema merging. It's designed for teams that maintain OpenAPI specs and want to keep their API documentation in sync without manual rewriting.","worth_installing":"Yes, if you maintain an OpenAPI spec and use Sphinx for documentation. The package is stable, permissively licensed, and has low install friction. Maintenance is aging (185 days since last release), so verify compatibility with your Sphinx version before adopting. No known security vulnerabilities."},"id":"sphinxcontrib-openapi","links":{"html":"https://skillfed.io/packages/sphinxcontrib-openapi","md":"https://skillfed.io/packages/sphinxcontrib-openapi.md","pypi":"https://pypi.org/project/sphinxcontrib-openapi/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2026-02-10","license_spdx":"BSD-3-Clause","license_treatment":"permissive","name":"sphinxcontrib-openapi","python_support":"supports_current","summary":"OpenAPI (fka Swagger) spec renderer for Sphinx"},"popularity":{"monthly_downloads":320278,"position":7637,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.9.0"}
