-
-
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 file: make sphinx or mkdocs configuration required for projects using Sphinx or MkDocs #11852
Conversation
This comment was marked as off-topic.
This comment was marked as off-topic.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great to me. It seems like we're unblocking ourselves for supporting build.jobs.build
for other projects while doing the deprecation here?
I took a quick look at this code and it seems to be correct. However, I've tried running the Docusaurus example from #11810 and it still breaks with Adding the following chunk makes that example to work correctly: diff --git a/readthedocs/doc_builder/director.py b/readthedocs/doc_builder/director.py
index ce93c967c..fab8ecfd6 100644
--- a/readthedocs/doc_builder/director.py
+++ b/readthedocs/doc_builder/director.py
@@ -307,6 +307,12 @@ class BuildDirector:
if self.data.config.build.jobs.create_environment is not None:
self.run_build_job("create_environment")
return
+
+ # If the builder is generic, we have nothing to do here,
+ # as the commnads are provided by the user.
+ if self.data.config.doctype == GENERIC:
+ return
+
self.language_environment.setup_base()
# Install I think we need to do something similar for those jobs we don't want to run when it's a |
We updated these dates there to move faster.
I implemented my previous comment in #11863. |
Continues the work done in #11852 to allow builds without `sphinx` or `mkdocs` config keys to work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fine. This is ready to merge 👍🏼
This allows for users to keep using the new overrides without worrying about sphinx/mkdocs, while giving enough time to old users to migrate their projects to give an explicit path.
Some notes
conf.py
/mkdocs.yml
from the repository #10637sphinx
ormkdocs
#11810