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

RTD: hard to understand what fails, the message doesn't include failing cause #6728

Open
khsrali opened this issue Jan 23, 2025 · 3 comments
Labels
good first issue Issues that should be relatively easy to fix also for beginning contributors

Comments

@khsrali
Copy link
Contributor

khsrali commented Jan 23, 2025

It shows many deprecation warnings that we don't need to worry about. and that makes searching for the word 'warning' difficult.

Even if you search and look carefully, you realize the actual warning message that causes the built to fail is not shown! 💁

at the moment the command is:
uv run sphinx-build -T -W --keep-going -b html -d _build/doctrees -D language=en docs/source $READTHEDOCS_OUTPUT/html

@khsrali khsrali added the good first issue Issues that should be relatively easy to fix also for beginning contributors label Feb 11, 2025
@ayushjariyal
Copy link
Contributor

@khsrali Is this issue still unresolved?

@khsrali
Copy link
Contributor Author

khsrali commented Feb 15, 2025

Yes, it's open!

You'll have to understand if (and why) the log would be different with or without uv

If the log is the same, how to "hide" deprecation warnings, and specifically emphasis what is the problem.

To experiment with this you can start by changing something "silly" in the documentation that would possibly break the build.

Then having your local setup all set, try to build via sphinx. And propose a solution by ideally changing only the main command:

uv run sphinx-build -T -W --keep-going -b html -d _build/doctrees -D language=en docs/source $READTHEDOCS_OUTPUT/html

@ayushjariyal
Copy link
Contributor

Got it!
I’ll test the build with and without uv, check for log differences, and propose a minimal adjustment to suppress non-critical warnings while keeping errors clear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issues that should be relatively easy to fix also for beginning contributors
Projects
None yet
Development

No branches or pull requests

2 participants