Development: inv docker.compilebuildtool should build everything by default

[akordata]

Details

Following the development installation instructions, I chose to build from version "latest", and also changed the default branch to "main" in the Admin settings (to account for this issue).

Expected Result

I am not sure what the expected result should be or how to fix it.

Actual Result

Here's a screenshot of the build and error logs:

[akordata]

Just for clarity, I allocated 8 GB of RAM to Docker and manually overrode the execution timeout to 15 minutes just to give it as much time as reasonable. I'm still running into this issue. I'm also getting different error messages between build failures, and suspect it might be due to some sort of race condition. Also, the error messages don't appear to be related to any of the other output. Might there have been an issue with provisioning, where maybe the provisioning didn't complete successfully?

[humitos]

Hi @akordata! The problem I see in your local setup is that it's compiling the Python version at build time because it wasn't pre-compiled. Take a look at the note from the link you posted (https://dev.readthedocs.io/en/latest/install.html#check-that-everything-works) and try running that command (inv docker.compilebuildtool) to pre-compile all the allowed versions.

After running that command (it takes a while), re-run your build on Read the Docs and it should work just fine. Let me know.

[akordata]

Hi @humitos, I am actually running into the same issue even after running the pre-compile command and am investigating further. Will follow up.

[humitos]

I'm closing this issue since we didn't have any response here. Feel free to add another comment if there is anything in our side to do.

[akordata]

Hi @humitos,
It's not immediately obvious that what is provided in the documentation is not a complete instruction, what command line arguments are necessary or possible for the compilebuildtool function call, and how to invoke them. After some digging I found the RTD_DOCKER_BUILD_SETTINGS in constants_docker.py. Perhaps this could be made more explicit in the documentation, the way it is with the other commands?

[humitos]

There is no argument required/needed to call inv docker.compilebuildtool. There is a warning note saying that we strongly recommend executing this command if you want to build documentation on the development instance.

[akordata]

@humitos I'm not sure what to say. Running the command without any arguments produced an error and did not work for me. Running it with arguments (the two examples below) did work, and I was able to build locally after that.

inv docker.compilebuildtool python mambaforge-22.9
inv docker.compilebuildtool python 3.10

[humitos]

Oh, you are right. It seems that it requires a tool and version. We should update that command to build everything by default I think. I'm re-opening the issue to do that. Thanks!

[humitos]

Maybe it could accept a --all attribute or similar.