On Wed, Apr 27, 2022 at 1:27 PM Nicolas Dechesne < [email protected]> wrote:
> > > On Wed, Apr 27, 2022 at 1:17 PM Nicolas Dechesne < > [email protected]> wrote: > >> >> >> On Wed, Apr 27, 2022 at 10:59 AM Michael Opdenacker via >> lists.yoctoproject.org <michael.opdenacker= >> [email protected]> wrote: >> >>> >>> On 4/27/22 10:18, Jose Quaresma wrote: >>> > >>> > >>> > In the HTML page it is fine, the &YOCTO_DOC_VERSION is 4.0 >>> > >>> https://docs.yoctoproject.org/4.0/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone >>> > >>> > In the dev version the &YOCTO_DOC_VERSION is not replaced by dev >>> > >>> https://docs.yoctoproject.org/dev/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone >>> >>> >>> That's *very weird* because the substitution happened in >>> https://docs.yoctoproject.org/dev/brief-yoctoprojectqs/index.html but >>> not in >>> >>> https://docs.yoctoproject.org/dev/migration-guides/migration-4.0.html#release-notes-for-4-0-kirkstone >>> (same version). >>> >>> When I build the docs locally things look fine. Any ideas what could >>> cause this? >>> >> >> I can reproduce the issue when building locally. I am using Sphinx==4.4.0 >> > > oh... It's because the file release-notes-4.0.rst is included with a > ..include statement. The variable mapping is done with a custom Sphinx > extension (yocto-vars.py) which is triggered for the 'source-read' event. > So perhaps this event is not triggered when using an include statement.. > let me check more on that.. > yes, that seems correct. I don't think we should continue to use the include directive here. Since you try to make one section (for 3.4 and 4.0) with the migration and the release notes, I think something along these lines would work, maybe there is simpler.. diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst index 20c6ab9d4..4597506d0 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 c22ea814d..d57c955eb 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 d737b9d43..a8e6b4c33 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 000000000..81476c4ad --- /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 000000000..7062f9d24 --- /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 > >> >>> >>> Michael. >>> >>> -- >>> Michael Opdenacker, Bootlin >>> Embedded Linux and Kernel engineering >>> https://bootlin.com >>> >>> >>> >>> >>>
-=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#56913): https://lists.yoctoproject.org/g/yocto/message/56913 Mute This Topic: https://lists.yoctoproject.org/mt/90728111/21656 Group Owner: [email protected] Unsubscribe: https://lists.yoctoproject.org/g/yocto/unsub [[email protected]] -=-=-=-=-=-=-=-=-=-=-=-
