Post: deprecate config files without sphinx or mkdocs configuration #342
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
content/posts/deprecate-config-files-without-sphinx-or-mkdocs-config.md
Outdated
Show resolved
Hide resolved
ericholscher
approved these changes
Dec 12, 2024
Yeah, that's also part of the deprecation. |
humitos
reviewed
Dec 13, 2024
content/posts/deprecate-config-files-without-sphinx-or-mkdocs-config.md
Outdated
Show resolved
Hide resolved
|
@humitos we should probably post this this week if we want it to go out before Christmas. |
stsewd
added a commit
to readthedocs/readthedocs.org
that referenced
this pull request
Dec 23, 2024
…s using Sphinx or MkDocs (#11852) - This introduces a breaking change for users overriding the new (undocumented) jobs (create_environment, install, build.html and friends). This is, if they have overridden any of those jobs without explicitly declaring a Sphinx or MkDocs key, we will no longer run the sphinx/mkdocs commands, not their setup. - This hardcodes the dates from readthedocs/website#342 to through an error to users using the configuration file without an explicit sphinx/mkdocs configuration. 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 - We are allowing to use sphinx/mkdocs and probably other keys with build.commands, even if those keys don't affect the build in anything. Not really something that "interrupt" users in any way, but it can be missleading. - A next step should be to not make python required at all, right now we still create a virtual environment. We probably want to create a virtual env only if python was provided in the list of build.tools. ---- - Ref: readthedocs/website#342 - Closes #10637 - Closes #11819 - Closes #11810 - Closes #11216 --------- Co-authored-by: Manuel Kaufmann <[email protected]>
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.
Ref:
conf.py/mkdocs.ymlfrom the repository readthedocs.org#10637📚 Documentation preview 📚: https://readthedocs-about--342.org.readthedocs.build/