👌 sphinx-test-reports: a tr_extra_options configuration error is shown as a Sphinx crash report instead of a configuration error
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 81/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Find the builder-inited check that validates tr_extra_options and read how it currently raises InvalidConfigurationError. Change the raised error to Sphinx's ConfigError or ExtensionError, keeping the message, then add or update a test that pins the plain Configuration error: output with -q and confirms there is no crash report or issue prompt.
Written by the indexing model from the issue text.
Description
Since #2162 a tr_extra_options that names a built-in option (Status, Suite, …) or two names differing only in case stops the build at builder-inited with InvalidConfigurationError. Measured in that round's review (C12): the stop is shown as Sphinx's FULL crash report — "Sphinx error!", the Versions block, a traceback and "please open an issue at https://github.com/sphinx-doc/sphinx/issues/" — for what is the user's own configuration mistake, and the one-line reason sits at the very end.
Fix shape: raise a sphinx.errors.ConfigError (or ExtensionError) from the builder-inited check, which Sphinx prints as a plain Configuration error: line without the traceback and the issue prompt; keep the message. One pin on the message's shape (-q included: the info line about lower-casing is already silent there).
- Dominant language
- Python
- Stars
- 309
- Forks
- 103
- Avg merge
- 11h 26m
- Merged PRs (30d)
- 118
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 useblocks/sphinx-needs
-
documentation pkg: sphinx-needs
Difficulty 1/5 Under an hour Newbie friendliness 82/100
useblocks/sphinx-needs#2255 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
useblocks/sphinx-needs#2253 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
useblocks/sphinx-needs#2251 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
useblocks/sphinx-needs#2249 ·
Maintainers usually reply within 1 day
-
documentation pkg: sphinx-test-reports
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
useblocks/sphinx-needs#2247 ·
Maintainers usually reply within 1 day
All issues in useblocks/sphinx-needs
Similar issues
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
btclib-org/btclib-node#1955 ·
Maintainers usually reply within 1 day
-
documentation v0.9.2
Difficulty 2/5 Half a day Newbie friendliness 72/100
khuisman/mcp-gee-sweet#1033 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ossf/cve-bin-tool#5966 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 2 days
-
write_iceberg ignores the table's write.parquet.compression-codec propertyPossibly taken @YuangGao claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Eventual-Inc/Daft#7606 ·
Maintainers usually reply within 1 day