-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Better error message when using build.tools.python
without build.os
#8912
Comments
Had same issue when building documentation of my project, and found out that I had to configure See the documentation about # Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python
build:
os: ubuntu-20.04 # <- add this line
tools:
python: "3.10"
# Configuration for Sphinx documentation
sphinx:
configuration: docs/conf.py
fail_on_warning: true |
Hmm, is there any reason that build.os needs to be required to use build.tools? There's only one option at the moment and I'm not sure if most users will care what version of Linux they build on. |
Hi! Yeah, Note that I created a branch in
In simple words, having a default here has avoided us to move forward in the past. We experienced similar issues with |
Yes, it should be possible to provide a better message |
But presumably if I don't specify |
We have an open issue for this at #8861 where you can read and comment about the discussion. |
build.tools.python
without build.os
Need to specify the os to specify python version readthedocs/readthedocs.org#8912
Why is |
@cjw296 the process to build the documentation itself has to run on a OS. We used the approach of having a "default OS" in the past and it's more problematic than useful to the large scale of users we have. We think that explicitly defining the dependencies is good practice and helps people to create reproducible builds over time. |
This is required. The error message is misleading [1]. [1] readthedocs/readthedocs.org#8912 Signed-off-by: Stephen Finucane <stephen@that.guru>
This is required. The error message is misleading [1]. [1] readthedocs/readthedocs.org#8912 Signed-off-by: Stephen Finucane <stephen@that.guru>
This is required. The error message is misleading [1]. [1] readthedocs/readthedocs.org#8912 Signed-off-by: Stephen Finucane <stephen@that.guru>
This is now required, apparently. See: - readthedocs/readthedocs.org#8861 (comment) - readthedocs/readthedocs.org#8912
This is now required, apparently. See: - readthedocs/readthedocs.org#8861 (comment) - readthedocs/readthedocs.org#8912
The ``build.os`` needs to be set in the readthedocs configuration file, see readthedocs/readthedocs.org#8912.
The ``build.os`` needs to be set in the readthedocs configuration file, see readthedocs/readthedocs.org#8912.
The ``build.os`` needs to be set in the readthedocs configuration file, see readthedocs/readthedocs.org#8912.
This is now required, apparently. See: - readthedocs/readthedocs.org#8861 (comment) - readthedocs/readthedocs.org#8912 (cherry picked from commit JonathonReinhart/scuba@4b89e6e178)
Also, we have improved this message as well: I think this issue is already solved. Feel free to re-open if you consider. |
Looks like there is an |
Details
Expected Result
I would expect the following simple
.readthedocs.yaml
file to work:Actual Result
I see the following build error:
For now I'll just remove this option.
The text was updated successfully, but these errors were encountered: