-
-
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
Config: avoid default sphinx/mkdocs steps #11819
Comments
We default to use sphinx if none of the options are specified, changing that default will be a breaking change. Maybe we can add another key/option to specify that a "generic" builder is being used, or to signal that all steps shouldn't use the defaults (build.keep_default_jobs: false). |
I don't want to add another key for this -it doesn't seem needed and adds a lot of complexity. What @agjohnson suggested in #11810 (comment) is a good first step here.
There are very few projects without The way to explicitly tell Read the Docs to run default jobs should be by defining |
My idea was loose too, there are probably more cases out side |
I think we should first deprecate the default behavior before changing it, or trying to guess if Sphinx should be used or not. |
Ideally, we would wait for deprecation, but given how important |
I agree with @agjohnson here. However, @stsewd, you can do both at the same time:
With the implementation, review and testing time; it will be close to Jan 10th by that time 😄 |
With the addition of
build.jobs.builds
and friends, we now need to figure out how to avoid the default build jobs/commands that are triggered from the Sphinx/MkDocs builders. This PR illustrates what is happening and needs to change:sphinx
ormkdocs
#11810The caveat here is that some projects still do use the Sphinx builder without specifying the
sphinx
configuration key. We should find a plan that supports all these use cases, probably without user intervention. Long term, sphinx and mkdocs should be mandatory for using either of these builders.The text was updated successfully, but these errors were encountered: