diff mbox series

[v2,31/37] docs/sphinx: include kernel-doc script as a dependency

Message ID 20250114113821.768750-32-alex.bennee@linaro.org
State New
Headers show
Series maintainer updates for jan '25 (semihosting, gdb, plugins, docs) pre-PR | expand

Commit Message

Alex Bennée Jan. 14, 2025, 11:38 a.m. UTC 
When we update the script we should rebuild the docs. Otherwise
breaking changes made to the kdoc script don't become apparent until
later.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 docs/sphinx/depfile.py | 3 +++
 1 file changed, 3 insertions(+)

Comments

Pierrick Bouvier Jan. 14, 2025, 6:24 p.m. UTC | #1 
On 1/14/25 03:38, Alex Bennée wrote:
> When we update the script we should rebuild the docs. Otherwise
> breaking changes made to the kdoc script don't become apparent until
> later.
> 
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
> ---
>   docs/sphinx/depfile.py | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/docs/sphinx/depfile.py b/docs/sphinx/depfile.py
> index e74be6af98..d3c774d28b 100644
> --- a/docs/sphinx/depfile.py
> +++ b/docs/sphinx/depfile.py
> @@ -31,6 +31,9 @@ def get_infiles(env):
>           for path in Path(static_path).rglob('*'):
>               yield str(path)
>   
> +    # also include kdoc script
> +    yield str(env.config.kerneldoc_bin[1])
> +
>   
>   def write_depfile(app, exception):
>       if exception:

Reviewed-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
diff mbox series

Patch

diff --git a/docs/sphinx/depfile.py b/docs/sphinx/depfile.py
index e74be6af98..d3c774d28b 100644
--- a/docs/sphinx/depfile.py
+++ b/docs/sphinx/depfile.py
@@ -31,6 +31,9 @@  def get_infiles(env):
         for path in Path(static_path).rglob('*'):
             yield str(path)
 
+    # also include kdoc script
+    yield str(env.config.kerneldoc_bin[1])
+
 
 def write_depfile(app, exception):
     if exception: