rtd is broken due to sphinxcontrib-details-directive
Maintainers usually reply within 1 day
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
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
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from NNPDF/yadism
-
Add TMC documentationPossibly taken @jekoorn claimed this 23 days ago. Opendocumentation
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
NNPDF/yadism#386 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Maintainers usually reply within 1 day
-
physics
Difficulty 5/5 Over a week Newbie friendliness 8/100
NNPDF/yadism#354 · 1 comment ·
Maintainers usually reply within 1 day
-
Swap `Q0` and `nf0` for `Qref` and `nfref`Possibly taken @ashishsoni-ai claimed this 33 days ago. Openrefactor
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
Maintainers usually reply within 1 day
-
Fix pydocstyleOpendocumentation good first issue
Difficulty 3/5 1-2 days Newbie friendliness 45/100
NNPDF/yadism#263 · 3 comments ·
Maintainers usually reply within 1 day
Similar issues
-
Layout accepts a step threshold of 0 or less, then in-toto-verify crashes with StopIterationPossibly taken @BahaaMattar claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
needs discussion
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
openfga/openfga.dev#1436 · 1 comment ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
usb-device-hid: MouseInterface reports bInterfaceProtocol 1 (keyboard) instead of 2Possibly taken @Duhan07 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
micropython/micropython-lib#1176 ·