{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"A Sphinx extension that lets you embed Jinja2 templates directly into reStructuredText documentation, generating dynamic content at build time.","skillfed_tags":["template-engine","documentation-generation"],"use_cases":["Generate API documentation tables or lists by iterating over structured data in conf.py.","Conditionally include or exclude documentation sections based on configuration flags.","Apply custom formatting to template variables using Jinja filters.","Load and render reusable documentation templates from external Jinja files.","Maintain DRY documentation by templating repetitive content patterns."],"what_it_does":"sphinx-jinja is a Sphinx extension that adds a jinja directive to reStructuredText, allowing you to embed Jinja2 template code directly in your documentation source. At build time, the extension renders these templates using contexts you define in your Sphinx conf.py, producing dynamic RST content that Sphinx then processes normally. You configure contexts, custom filters, tests, globals, and Jinja environment settings in your configuration file, then reference them by name in your RST directives.\n\nThe extension is useful when your documentation needs to be generated from data structures, iterate over collections, or apply conditional logic\u2014tasks that plain RST cannot express. You can inline templates in your RST files or load them from separate Jinja files using the file option. It also supports header-level management and debug output to inspect the generated RST before final rendering.","worth_installing":"Yes, if you need dynamic content generation in Sphinx and are comfortable with dormant maintenance. The package is stable, has no known vulnerabilities, and supports Python 3.6 through 3.10. However, because the last release was in 2022 and the repository has seen no commits since 2023-11-02, do not expect bug fixes or compatibility updates for future Sphinx or Python releases. Suitable for established projects where the feature set is complete; risky for new projects requiring ongoing support."},"id":"sphinx-jinja","links":{"html":"https://skillfed.io/packages/sphinx-jinja","md":"https://skillfed.io/packages/sphinx-jinja.md","pypi":"https://pypi.org/project/sphinx-jinja/"},"maintenance":{"status":"dormant"},"meta":{"latest_release":"2022-07-05","license_spdx":null,"license_treatment":"permissive","name":"sphinx-jinja","python_support":"supports_current","summary":"includes jinja templates in a documentation"},"popularity":{"monthly_downloads":2888200,"position":2842,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"2.0.2"}