Blog post: partially or completely override the build process #345
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
humitos
reviewed
Jan 15, 2025
humitos
approved these changes
Jan 16, 2025
ericholscher
approved these changes
Jan 16, 2025
Comment on lines
+77
to
+79
| We recommend using [`build.jobs`](https://docs.readthedocs.io/en/stable/config-file/v2.html#build-jobs) over [`build.commands`](https://docs.readthedocs.io/en/stable/config-file/v2.html#build-commands), | ||
| as it offers the same functionality as `build.commands`, but in a more structured way that allows you to define different commands for each format, | ||
| while also supporting installing system dependencies via `build.apt_packages`. |
There was a problem hiding this comment.
We should probably put a section in the docs about when each should be used. I think build.commands is basically for when you want us to run no additional setup, and the reason apt_packages doesn't work is because we aren't doing any kind of environment setup, right?
There was a problem hiding this comment.
build.jobs can also be used to not run any additional steps, they are basically the same now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
preview at https://readthedocs-about--345.org.readthedocs.build/blog/2025/01/override-build-process-with-build-jobs/index.html
Closes https://github.com/readthedocs/readthedocs-ops/issues/1582
📚 Documentation preview 📚: https://readthedocs-about--345.org.readthedocs.build/