Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Raise errors when building with sphinx-build #13388

Open
fxmarty-amd opened this issue Feb 24, 2025 · 0 comments
Open

Raise errors when building with sphinx-build #13388

fxmarty-amd opened this issue Feb 24, 2025 · 0 comments
Labels

Comments

@fxmarty-amd
Copy link

Describe the bug

Hi,

Errors are not raised when building a documentation with sphinx-build version 8.1.3.

There is an option --exception-on-warning to forcibly raise errors on warnings, but there is no option to raise errors only on errors.

Related (closed and locked) request: #10397 (comment)

Thank you!

How to Reproduce

I can't share my setup, but any sphinx doc with an error will work. For example, a doc with a "malformated" table:

+------------------------------+-----------------------------------------------+
| File name                    | Additional  stuff                             |
+------------------------------+-----------------------------------------------+
| foo.json                     | This is a really long description really really long |
+------------------------------+-----------------------------------------------+
| boo.json                     | small desc                                    |
+------------------------------+-----------------------------------------------+

Having this table, there is an error in the logs but no error is actually raised during build.

Environment Information

Platform:              linux; (Linux-5.15.167.4-microsoft-standard-WSL2-x86_64-with-glibc2.35)
Python version:        3.10.14 (main, May  6 2024, 19:42:50) [GCC 11.2.0])
Python implementation: CPython
Sphinx version:        8.1.3
Docutils version:      0.21.2
Jinja2 version:        3.1.4
Pygments version:      2.18.0

Sphinx extensions

Additional context

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant