forked from apache/airflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Automatically replace current Airflow version in docs (apache#15484)
There are a number of places where we want the current Airflow version to appear in the docs, and sphinx has this build in, `|version|`. But sadly that only works for "inline text", it doesn't work in code blocks or inline code. This PR also adds two custom plugins that make this work inspired by https://github.com/adamtheturtle/sphinx-substitution-extensions (but entirely re-written as that module Just Didn't Work)
- Loading branch information
Showing
10 changed files
with
212 additions
and
84 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
|
|
||
| import os | ||
|
|
||
|
|
||
| def copy_docker_compose(app, exception): | ||
| """Sphinx "build-finished" event handler.""" | ||
| from sphinx.builders import html as builders | ||
|
|
||
| if exception or not isinstance(app.builder, builders.StandaloneHTMLBuilder): | ||
| return | ||
|
|
||
| # Replace `|version|` in the docker-compose.yaml that we produce in the built docs | ||
| for path in app.config.html_extra_with_substituions: | ||
| with open(path) as file: | ||
| with open(os.path.join(app.outdir, os.path.basename(path)), "w") as output: | ||
| for line in file: | ||
| output.write(line.replace('|version|', app.config.version)) | ||
|
|
||
|
|
||
| def setup(app): | ||
| """Setup plugin""" | ||
| app.connect("build-finished", copy_docker_compose) | ||
|
|
||
| app.add_config_value("html_extra_with_substituions", [], '[str]') | ||
|
|
||
| return { | ||
| 'parallel_write_safe': True, | ||
| } |
Oops, something went wrong.