Post: deprecate config files without sphinx or mkdocs configuration #342
+47
−0
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
| image: /images/deprecated-config-file-without-sphinx-or-mkdocs-config.jpg | ||
| image_credit: Photo by <a href="https://unsplash.com/@jernejgraj?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Jernej Graj</a> on <a href="https://unsplash.com/photos/photo-of-seashore-during-golden-hour-n44KHcbp1_E?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a> | ||
|
|
||
| We are announcing the deprecation of configuration files that do not contain a explicit `sphinx` or `mkdocs` configuration. |
There was a problem hiding this comment.
This seems like bad phrasing, because we support lots of configurations without those keys, especially with build.commands and new build.jobs syntax.
There was a problem hiding this comment.
build.commands yes, build.jobs still run sphinx commands. Anyway, what about "Deprecation of projects using Sphinx or MkDocs without an explicit configuration file"? Changed all the sentences to that.
ericholscher
approved these changes
Dec 12, 2024
Yeah, that's also part of the deprecation. |
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/