Build: don't run default steps if no sphinx
or mkdocs
#11810
Closed
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.
This PR modifies the build to not run default commands when the user doesn't specify
sphinx
ormkdocs
configs in the YAML file.This allows to use the following YAML file to build with Docusaurus, for example:
This is the structure I've been wanting to have to allow any type of doctool to work in our platform following the
build.jobs
pattern.The code deployed in production doesn't allow this because it runs automatically
create_environment
,install_core_dependencies
andinstall_requirements
even if the project is not using Python --which is incorrect. It fails with the generic error: "Unknown problem. There was a problem with Read the Docs while building your documentation"This PR detects if the user is defining
sphinx
ormkdocs
and if it's not, it doesn't run those jobs and leave the user to handle the build workflow completely.build.jobs.create_environment
andbuild.jobs.install
#11551