{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/4"},{"label":"Text Processing","url":"https://skillfed.io/packages/category/text-processing/2"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"},{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Provides a Python API to integrate Sphinx-generated documentation into web applications, enabling server-side search and interactive documentation features.","skillfed_tags":["sphinx-extension","web-integration"],"use_cases":["Embed searchable Sphinx documentation directly into a web application's help or docs section","Build a custom documentation portal that integrates with your application's authentication and UI","Serve dynamically generated or versioned documentation from a web backend","Add full-text search over Sphinx docs without hosting a separate documentation site"],"what_it_does":"sphinxcontrib-websupport is a Sphinx extension that exposes a Python API for embedding Sphinx documentation into web applications. Rather than serving static HTML, it lets you integrate live, searchable documentation directly into your web stack. It depends on Sphinx itself, Jinja2 for templating, and sphinxcontrib-serializinghtml for document serialization.\n\nThe package is positioned as a bridge between Sphinx's documentation generation and web application frameworks. It handles the server-side logic needed to serve documentation interactively\u2014particularly search functionality\u2014rather than as flat files. This is useful when you want documentation to feel native to your application rather than a separate portal.","worth_installing":"Yes, if you need to serve Sphinx documentation from a web application backend. The low install friction and permissive license make it straightforward to adopt. However, the aging maintenance status (746 days since last release) means you should verify compatibility with your target Sphinx version and be prepared to handle any issues independently or contribute fixes upstream."},"id":"sphinxcontrib-websupport","links":{"html":"https://skillfed.io/packages/sphinxcontrib-websupport","md":"https://skillfed.io/packages/sphinxcontrib-websupport.md","pypi":"https://pypi.org/project/sphinxcontrib-websupport/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2024-07-29","license_spdx":null,"license_treatment":"permissive","name":"sphinxcontrib-websupport","python_support":"supports_current","summary":"sphinxcontrib-websupport provides a Python API to easily integrate Sphinx documentation into your Web application"},"popularity":{"monthly_downloads":1355661,"position":4006,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"2.0.0"}
