← Back to issue list

Replace the `details` directive

View original Github issue

Metadata

Project
craft-parts
Number
#1454
Type
issue
State
closed
Author
jahn-junior
Labels
Status: Triaged Type: Documentation
Created
Updated
Closed

Current evaluation

Replaced documentation `details` directives with captioned `code-block` directives and removed sphinxcontrib-details-directive, eliminating the setuptools/pkg_resources workaround.

Resolution: closed resolved

Reason: The issue was closed as resolved after the documentation directives were replaced with captioned `code-block` equivalents and sphinxcontrib-details-directive was removed. This addressed the setuptools/pkg_resources dependency concern; no resolving PR or commit was exposed in the available record.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### What needs to get done Replace any `details` directives with `code-block` directives. We can nearly emulate the output of `details` with the `caption` attribute. ### Why it needs to get done We previously had to work around https://github.com/sphinx-contrib/sphinxcontrib-details-directive/issues/5 by adding `setuptools` as a dependency for the documentation. With the recent removal of `pkg_resources` in [setuptools v82.0.0](https://setuptools.pypa.io/en/stable/history.html#v82-0-0), we'd need to pin the version to continue using this directive.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Replaced documentation `details` directives with captioned `code-block` directives and removed sphinxcontrib-details-directive, eliminating the setuptools/pkg_resources workaround.
stealth/space-bunny-alpha — closed resolved Resolved in #1456 by replacing details directives with captioned code blocks and removing the sphinxcontrib-details-directive/setuptools workaround.
stealth/space-bunny-alpha — closed resolved Resolved the documentation task by replacing details with captioned code-block directives and removing sphinxcontrib-details-directive, avoiding the setuptools/pkg_resources conflict.
qwen/qwen3.6-35b-a3b — — Closed and resolved by replacing details directives with code-block directives. This eliminates the sphinxcontrib-details-directive dependency, avoiding conflicts with recent setuptools releases.
qwen/qwen3.6-35b-a3b — — Resolved by replacing details directives with code-block directives to eliminate a setuptools dependency conflict. The documentation update was implemented and tracked via internal Jira ticket CRAFT-5015.
qwen/qwen3.6-35b-a3b — — Closed to resolve a setuptools dependency conflict. The task to replace details directives with code-block directives was abandoned, with the work tracked internally via Jira ticket CRAFT-5015.
qwen3.6-35b-a3b-mtp-q6 — — Closed after triage and Jira ticket creation. The details directive was replaced with code-block to resolve the setuptools dependency conflict.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.