[dunfell][PATCH] sphinx: update link to bitbake docs

[dunfell][PATCH] sphinx: update link to bitbake docs

[Nicolas Dechesne]

The Sphinx based Bitbake documentation for dunfell release is published to
https://docs.yoctoproject.org/bitbake/1.46/.

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
---
 documentation/conf.py   | 2 +-
 documentation/index.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/documentation/conf.py b/documentation/conf.py
index 33d0ddcfd..b6d8073ee 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -82,7 +82,7 @@ extlinks = {
 
 # Intersphinx config to use cross reference with Bitbake user manual
 intersphinx_mapping = {
-    'bitbake': ('https://docs.yoctoproject.org/bitbake/', None)
+    'bitbake': ('https://docs.yoctoproject.org/bitbake/1.46', None)
 }
 
 # -- Options for HTML output -------------------------------------------------
diff --git a/documentation/index.rst b/documentation/index.rst
index 937692ce0..71ed4e76f 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -33,7 +33,7 @@ Welcome to the Yocto Project Documentation
    Profile and Tracing Manual <profile-manual/profile-manual>
    Application Development and the Extensible SDK (eSDK) <sdk-manual/sdk-manual>
    Toaster Manual <toaster-manual/toaster-manual>
-   Bitbake User Manual <https://docs.yoctoproject.org/bitbake>
+   Bitbake User Manual <https://docs.yoctoproject.org/bitbake/1.46>
 
 .. toctree::
    :maxdepth: 1
-- 
2.30.0

Re: [docs] [dunfell][PATCH] sphinx: update link to bitbake docs

[Quentin Schulz]

Hi Nicolas,

On Mon, Jan 04, 2021 at 12:22:04PM +0100, Nicolas Dechesne wrote:
> The Sphinx based Bitbake documentation for dunfell release is published to
> https://docs.yoctoproject.org/bitbake/1.46/.
> 
> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
> ---
>  documentation/conf.py   | 2 +-
>  documentation/index.rst | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/documentation/conf.py b/documentation/conf.py
> index 33d0ddcfd..b6d8073ee 100644
> --- a/documentation/conf.py
> +++ b/documentation/conf.py
> @@ -82,7 +82,7 @@ extlinks = {
>  
>  # Intersphinx config to use cross reference with Bitbake user manual
>  intersphinx_mapping = {
> -    'bitbake': ('https://docs.yoctoproject.org/bitbake/', None)
> +    'bitbake': ('https://docs.yoctoproject.org/bitbake/1.46', None)
>  }
>  
>  # -- Options for HTML output -------------------------------------------------
> diff --git a/documentation/index.rst b/documentation/index.rst
> index 937692ce0..71ed4e76f 100644
> --- a/documentation/index.rst
> +++ b/documentation/index.rst
> @@ -33,7 +33,7 @@ Welcome to the Yocto Project Documentation
>     Profile and Tracing Manual <profile-manual/profile-manual>
>     Application Development and the Extensible SDK (eSDK) <sdk-manual/sdk-manual>
>     Toaster Manual <toaster-manual/toaster-manual>
> -   Bitbake User Manual <https://docs.yoctoproject.org/bitbake>
> +   Bitbake User Manual <https://docs.yoctoproject.org/bitbake/1.46>

Would it make sense to have an entry for that in poky.yaml? That way we
don't forget to fix it when tagging the new Yocto releases? (ideally if
there's a "master" equivalent for where 1.46 is in the URL, we might put
it there (or just plain '' if we can't).

E.g. YOCTO_BITBAKE_VERSION : "1.46"?

BTW, the version dropdown menu on bitbake documentation is broken, it
points to Yocto docs.

Quentin

Re: [docs] [dunfell][PATCH] sphinx: update link to bitbake docs

[Nicolas Dechesne]

On Mon, Jan 4, 2021 at 12:44 PM Quentin Schulz
<quentin.schulz@streamunlimited.com> wrote:
>
> Hi Nicolas,
>
> On Mon, Jan 04, 2021 at 12:22:04PM +0100, Nicolas Dechesne wrote:
> > The Sphinx based Bitbake documentation for dunfell release is published to
> > https://docs.yoctoproject.org/bitbake/1.46/.
> >
> > Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
> > ---
> >  documentation/conf.py   | 2 +-
> >  documentation/index.rst | 2 +-
> >  2 files changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/documentation/conf.py b/documentation/conf.py
> > index 33d0ddcfd..b6d8073ee 100644
> > --- a/documentation/conf.py
> > +++ b/documentation/conf.py
> > @@ -82,7 +82,7 @@ extlinks = {
> >
> >  # Intersphinx config to use cross reference with Bitbake user manual
> >  intersphinx_mapping = {
> > -    'bitbake': ('https://docs.yoctoproject.org/bitbake/', None)
> > +    'bitbake': ('https://docs.yoctoproject.org/bitbake/1.46', None)
> >  }
> >
> >  # -- Options for HTML output -------------------------------------------------
> > diff --git a/documentation/index.rst b/documentation/index.rst
> > index 937692ce0..71ed4e76f 100644
> > --- a/documentation/index.rst
> > +++ b/documentation/index.rst
> > @@ -33,7 +33,7 @@ Welcome to the Yocto Project Documentation
> >     Profile and Tracing Manual <profile-manual/profile-manual>
> >     Application Development and the Extensible SDK (eSDK) <sdk-manual/sdk-manual>
> >     Toaster Manual <toaster-manual/toaster-manual>
> > -   Bitbake User Manual <https://docs.yoctoproject.org/bitbake>
> > +   Bitbake User Manual <https://docs.yoctoproject.org/bitbake/1.46>
>
> Would it make sense to have an entry for that in poky.yaml? That way we
> don't forget to fix it when tagging the new Yocto releases? (ideally if
> there's a "master" equivalent for where 1.46 is in the URL, we might put
> it there (or just plain '' if we can't).
>
> E.g. YOCTO_BITBAKE_VERSION : "1.46"?

We could do something.. not sure what though, since for 'master' we
publish to /bitbake/, as you noticed.. Note that it's also broken in
gatesgarth branch.
The more I look at how we've integrated bitbake and yocto-docs, the
less I like it.. We try to pretend they are separate docs projects,
but they aren't really.. And it makes several things quite awkward..

>
> BTW, the version dropdown menu on bitbake documentation is broken, it
> points to Yocto docs.

That is one of the weird things we have..

>
> Quentin