Re: [docs] [PATCH] migration-guides: stop including documents with ".. include"


Quentin Schulz
 

Hi Michael,

On 4/27/22 14:33, Michael Opdenacker via lists.yoctoproject.org wrote:
From: Michael Opdenacker <michael.opdenacker@...>
Technically incorrect, it's Nicolas who's the author :)

git commit --author="Nicolas Dechesne <nicolas.dechesne@...>"

is the line to specify an author.

This prevented variables from being substituted through the
code in yocto-vars.py, at least in the files included this way.
I checked and the file actually gets passed to subst_vars_replace function and the output of that is correct. However, it does not make it to the output of the file where it is included. I cannot explain why without digging deep into Sphinx code. I think we might be able to use https://www.sphinx-doc.org/en/master/extdev/appapi.html#event-html-page-context instead, but haven't looked into it yet and does not seem like a clean way to do it (patching the html after rendering).

I think a proper bug report should be filed to Sphinx though.

Cheers,
Quentin

Reviewed-by: Michael Opdenacker <michael.opdenacker@...>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@...>
---
documentation/migration-guides/index.rst | 4 ++--
documentation/migration-guides/migration-3.4.rst | 6 ------
documentation/migration-guides/migration-4.0.rst | 2 --
documentation/migration-guides/release-3.4.rst | 10 ++++++++++
documentation/migration-guides/release-4.0.rst | 7 +++++++
5 files changed, 19 insertions(+), 10 deletions(-)
create mode 100644 documentation/migration-guides/release-3.4.rst
create mode 100644 documentation/migration-guides/release-4.0.rst
diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst
index 20c6ab9d4e..4597506d05 100644
--- a/documentation/migration-guides/index.rst
+++ b/documentation/migration-guides/index.rst
@@ -12,8 +12,8 @@ to move to one release of the Yocto Project from the previous one.
.. toctree::
migration-general
- migration-4.0
- migration-3.4
+ release-4.0
+ release-3.4
migration-3.3
migration-3.2
migration-3.1
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst
index c22ea814d6..d57c955eb4 100644
--- a/documentation/migration-guides/migration-3.4.rst
+++ b/documentation/migration-guides/migration-3.4.rst
@@ -1,6 +1,3 @@
-Release 3.4 (honister)
-======================
-
Migration notes for 3.4 (honister)
----------------------------------
@@ -274,6 +271,3 @@ Miscellaneous
examples in :term:`EXTRA_USERS_PARAMS`.
-.. include:: release-notes-3.4.rst
-.. include:: release-notes-3.4.1.rst
-.. include:: release-notes-3.4.2.rst
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst
index d737b9d431..a8e6b4c331 100644
--- a/documentation/migration-guides/migration-4.0.rst
+++ b/documentation/migration-guides/migration-4.0.rst
@@ -265,5 +265,3 @@ Miscellaneous changes
when parsing recipes. Any code depending on the previous behaviour will no longer
work - change any such code to explicitly use appropriate path variables instead.
-
-.. include:: release-notes-4.0.rst
diff --git a/documentation/migration-guides/release-3.4.rst b/documentation/migration-guides/release-3.4.rst
new file mode 100644
index 0000000000..81476c4adb
--- /dev/null
+++ b/documentation/migration-guides/release-3.4.rst
@@ -0,0 +1,10 @@
+Release 3.4 (honister)
+======================
+
+.. toctree::
+
+ migration-3.4
+ release-notes-3.4
+ release-notes-3.4.1
+ release-notes-3.4.2
+
diff --git a/documentation/migration-guides/release-4.0.rst b/documentation/migration-guides/release-4.0.rst
new file mode 100644
index 0000000000..7062f9d241
--- /dev/null
+++ b/documentation/migration-guides/release-4.0.rst
@@ -0,0 +1,7 @@
+Release 4.0 (kirkstone)
+=======================
+
+.. toctree::
+
+ migration-4.0
+ release-notes-4.0

Join yocto@lists.yoctoproject.org to automatically receive all group messages.