rtd is broken due to sphinxcontrib-details-directive

Open
#378 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@ashishsoni-ai is already working on this.

Since Oct 17, 2026.

  • #397 by @ashishsoni-ai — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

The failure comes from the sphinxcontrib.details.directive extension loaded by the Sphinx config in docs/source/conf.py, which imports pkg_resources. The directive is used in docs/source/theory/coeff-funcs.rst around line 118. Choose between pinning setuptools in the docs requirements or replacing the directive with inline details HTML, then confirm the docs build no longer raises the extension error. Done means the Read the Docs build succeeds. The maintainers have not settled which option to take.

Written by the indexing model from the issue text.

Description

dependencies documentation

rtd fails with

Extension error:
Could not import extension sphinxcontrib.details.directive (exception: No module named 'pkg_resources')

because setuptools finally stopped shipping that

The proper solution is https://github.com/sphinx-contrib/sphinxcontrib-details-directive/pull/9 , but I'm not sure on how active the authors are ... if nothing happens in the short term we should abandon the package and maybe just inline the HTML?

it is used here: https://github.com/NNPDF/yadism/blob/b2ef298b8a99ab9a32c1b89dfe5dd6b410e88be6/docs/source/theory/coeff-funcs.rst?plain=1#L118

Dominant language
Python
Stars
11
Forks
2
Avg merge
2d 13h
Merged PRs (30d)
6

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NNPDF/yadism

All issues in NNPDF/yadism

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.