{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/8"},{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"},{"label":"Software Distribution","url":"https://skillfed.io/packages/category/system-software-distribution"}],"enrichment":{"capability":"A Sphinx extension that automatically injects a Towncrier-generated changelog draft into documentation, displaying unreleased project version fragments.","skillfed_tags":["sphinx-extension","changelog-management","documentation-automation"],"use_cases":["Display unreleased changelog fragments in your project's documentation site during development.","Automatically generate a draft release notes section in Sphinx docs without manual maintenance.","Keep contributors and users informed of upcoming changes by embedding the towncrier draft in your docs.","Integrate changelog management into your Sphinx build pipeline for single-source documentation.","Override auto-generated version titles with custom release labels or status markers in the changelog."],"what_it_does":"sphinxcontrib-towncrier is a Sphinx extension that bridges Sphinx documentation builds with Towncrier, a changelog management tool. It provides an RST directive that automatically renders a draft changelog containing unreleased fragments into your documentation. The extension reads your project's towncrier configuration and injects the generated changelog at build time, allowing you to display work-in-progress release notes alongside your main documentation.\n\nThe package has two runtime dependencies: sphinx and towncrier. It supports Python 3.9 through 3.13 and is classified as alpha-stage software. The extension offers configurable version title generation modes (draft, sphinx-version, or sphinx-release) and allows you to override the title with custom text. It's used by projects like ansible/pylibssh and pypa/pip to keep changelog drafts visible during documentation builds.","worth_installing":"Yes, if you use both Sphinx and Towncrier for your project. The extension solves a real integration gap and is actively maintained. However, note that it is still alpha-stage software (version 0.5.0a0), so expect potential API changes. Install it when you want unreleased changelog fragments visible in your documentation builds without manual duplication."},"id":"sphinxcontrib-towncrier","links":{"html":"https://skillfed.io/packages/sphinxcontrib-towncrier","md":"https://skillfed.io/packages/sphinxcontrib-towncrier.md","pypi":"https://pypi.org/project/sphinxcontrib-towncrier/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-02-28","license_spdx":null,"license_treatment":"permissive","name":"sphinxcontrib-towncrier","python_support":"supports_current","summary":"An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version"},"popularity":{"monthly_downloads":163082,"position":10577,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.5.0a0"}