[RFC] Add recipe-yocto-docs

[RFC] Add recipe-yocto-docs

[akuster]

Hello,

I just finished creating the ability to build the yocto-doc via a recipe
( Thanks to everyone who helped with the sphinx migration)

http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=akuster/yocto_docs_recipe

There are several structural decision to me made.

Several of the dependency packages that currently reside in  other
layers so those might need to moved in core. 

The easy decision is where the yocto-doc recipe should live. I suspect
in meta-yocto.

The ones I am not sure are the ones needed to support sphinx. Do we want
these only as Native? Do we want this sphinx in core?

This may be a gateway to allow including the docs in an SDK image. Add
layer based docs. Create an Docs installer, bitbake-docs, etc.

The recipes most likely need a bit of cleaning up. I did test a native
version of the index.html and that worked fine.


- armin

Re: [docs] [RFC] Add recipe-yocto-docs

[Nicolas Dechesne]

hey Armin,

On Sun, Nov 1, 2020 at 7:40 PM akuster <akuster808@gmail.com> wrote:
>
> Hello,
>
> I just finished creating the ability to build the yocto-doc via a recipe
> ( Thanks to everyone who helped with the sphinx migration)
>
> http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=akuster/yocto_docs_recipe

This is cool ;)

>
> There are several structural decision to me made.
>
> Several of the dependency packages that currently reside in  other
> layers so those might need to moved in core.
>
> The easy decision is where the yocto-doc recipe should live. I suspect
> in meta-yocto.
>
> The ones I am not sure are the ones needed to support sphinx. Do we want
> these only as Native? Do we want this sphinx in core?

If we go this route, I think we need all dependencies in Core.

>
> This may be a gateway to allow including the docs in an SDK image. Add
> layer based docs. Create an Docs installer, bitbake-docs, etc.

I was wondering about bitbake-docs.. and where we should have such a recipe..

>
> The recipes most likely need a bit of cleaning up. I did test a native
> version of the index.html and that worked fine.

We could use this recipe to test docs as part of AB testing. Though I
am not sure if yocto-docs master-next is included in poky master-next.

That said for building the docs website (docs.yp.org), we would
probably not use this bitbake recipe, since we have several branches
to build to create the whole website.

>
>
> - armin
>
>
>
>
> 
>

Re: [docs] [RFC] Add recipe-yocto-docs

[akuster]

On 11/2/20 12:40 AM, Nicolas Dechesne wrote:
> hey Armin,
>
> On Sun, Nov 1, 2020 at 7:40 PM akuster <akuster808@gmail.com> wrote:
>> Hello,
>>
>> I just finished creating the ability to build the yocto-doc via a recipe
>> ( Thanks to everyone who helped with the sphinx migration)
>>
>> http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=akuster/yocto_docs_recipe
> This is cool ;)
>
>> There are several structural decision to me made.
>>
>> Several of the dependency packages that currently reside in  other
>> layers so those might need to moved in core.
>>
>> The easy decision is where the yocto-doc recipe should live. I suspect
>> in meta-yocto.
>>
>> The ones I am not sure are the ones needed to support sphinx. Do we want
>> these only as Native? Do we want this sphinx in core?
> If we go this route, I think we need all dependencies in Core.
>
>> This may be a gateway to allow including the docs in an SDK image. Add
>> layer based docs. Create an Docs installer, bitbake-docs, etc.
> I was wondering about bitbake-docs.. and where we should have such a recipe..

if sphinx and it's dependencies are in core, then bitbake manual could
be there too
>
>> The recipes most likely need a bit of cleaning up. I did test a native
>> version of the index.html and that worked fine.
> We could use this recipe to test docs as part of AB testing. Though I
> am not sure if yocto-docs master-next is included in poky master-next.

it does open up the possibility to have a mock doc in meta-skeleton and
have it part of oe-selftest. Or have as a template if someone want to
create sphinx doc for the layer or product.
>
> That said for building the docs website (docs.yp.org), we would
> probably not use this bitbake recipe, since we have several branches
> to build to create the whole website.
at some point, the recipes can be changed and use branching and be
updated at a dot release time.

>>
>> - armin
>>
>>
>>
>>
>> 
>>