🤖 Set build config via Sphinx ext #2360
Open
+149
−1
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
Closed
This is an initial change allowing for restructuring how the config settings are computed and putting that logic into a dedicated Sphinx extension. The idea is that this extension may have multiple callbacks that set configuration for Sphinx based on tags and the environment state. As an example, this in-tree extension implements setting the `is_eol` variable in Jinja2 context very early in Sphinx life cycle. It does this based on inspecting the state of current Git checkout as well as reading a config file listing EOL and supported versions of `ansible-core`. The configuration format is TOML as it's gained a lot of the ecosystem adoption over the past years and its parser made its way into the standard library of Python, while PyYAML remains a third-party dependency. Supersedes ansible#2251.
webknjaz
force-pushed
the
maintenance/extension-driven-build-config
branch
from
8ef3352 to
ab0e151
Compare
oraNod
added
doc builds
webknjaz
commented
Jan 17, 2025
| logger.info(str(lookup_err)) | ||
| return | ||
|
|
||
| config.html_context['is_eol'] = _is_eol_build( |
There was a problem hiding this comment.
@oraNod this is what sets that value into the variable defined in conf.py. It basically replaces the old hardcoded value.
webknjaz
commented
Jan 17, 2025
| def from_dict(cls, raw_dist: dict[str, list[str]]) -> 'Distribution': | ||
| return cls( | ||
| **{ | ||
| kind.replace('-', '_'): versions |
There was a problem hiding this comment.
The dataclass has to have snake_case attrs so this is doing that conversion. It effectively maps end-of-life in the TOML config to end_of_life.
webknjaz
commented
Jan 17, 2025
| 'stable-2.14', | ||
| 'stable-2.13', | ||
| ] | ||
| supported = [ |
There was a problem hiding this comment.
@oraNod did you plan to use this list somehow? I just copied it, but it's not actually used anywhere.
webknjaz
commented
Jan 17, 2025
Comment on lines
+14
to
+25
| [distribution.ansible-core] | ||
| end-of-life = [ | ||
| 'stable-2.15', | ||
| 'stable-2.14', | ||
| 'stable-2.13', | ||
| ] | ||
| supported = [ | ||
| 'devel', | ||
| 'stable-2.18', | ||
| 'stable-2.17', | ||
| 'stable-2.16', | ||
| ] |
There was a problem hiding this comment.
@oraNod things here are the same as in the other mapping. Did you expect them to differ at some point? What's the semantic meaning you were going for?
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.
This is an initial change allowing for restructuring how the config settings are computed and putting that logic into a dedicated Sphinx extension. The idea is that this extension may have multiple callbacks that set configuration for Sphinx based on tags and the environment state.
As an example, this in-tree extension implements setting the
is_eolvariable in Jinja2 context very early in Sphinx life cycle. It does this based on inspecting the state of current Git checkout as well as reading a config file listing EOL and supported versions ofansible-core.The configuration format is TOML as it's gained a lot of the ecosystem adoption over the past years and its parser made its way into the standard library of Python, while PyYAML remains a third-party dependency.
Supersedes #2251.