Repository navigation
Add static TOML configuration support with Sphinx.toml - #14718
Open
Shashankrawat1504 wants to merge 4 commits into
Open
Shashankrawat1504 wants to merge 4 commits into
Shashankrawat1504 wants to merge 4 commits into
Conversation
Shashankrawat1504
changed the title
This branch has not been deployed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #9040
What does this PR change?
Sphinx can now use Sphinx.toml as a static alternative to conf.py.
Adds support for loading configuration from Sphinx.toml using Python's standard tomllib.
Keeps conf.py for projects that require dynamic Python configuration.
conf.py and Sphinx.toml cannot be used together.
Applies the existing Sphinx configuration validation and CLI overrides to TOML values.
Supports extensions, paths, themes, and other standard Sphinx configuration options.
Provides clear errors for invalid TOML and configuration conflicts.
Adds tests covering parsing, validation, CLI behavior, paths, extensions, serialization, and parallel builds.
Updates the documentation with examples and TOML limitations.
Sphinx.toml is intended for projects that need declarative configuration without executing Python code.