From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-yb1-f178.google.com (mail-yb1-f178.google.com [209.85.219.178]) by mx.groups.io with SMTP id smtpd.web10.27758.1590392018712871889 for ; Mon, 25 May 2020 00:33:39 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@linaro.org header.s=google header.b=EIgGIhNz; spf=pass (domain: linaro.org, ip: 209.85.219.178, mailfrom: nicolas.dechesne@linaro.org) Received: by mail-yb1-f178.google.com with SMTP id y18so551657ybb.3 for ; Mon, 25 May 2020 00:33:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=zZ4ymocB12gj0tduN0d1jr/vmBKot0zf0VYWHsW//Zg=; b=EIgGIhNzapNuh6Bu+WGh1c6Nr84hJQOlXF/tW/slXHulNGauMKFTVOEYxX5xlwTVr+ IZBYYA6ETUxCjLHdTNtNFBbZTTzvUnG6hYQGgziLp4nbnkMTa0qWjkqgYxDSH1Hl1pxA avpYPcCyVCk4Zo1CdnkJpPufd7+9waXK4DE7yoEqYA2pgLQhc+nvC/sdQ4IclotIKUfb tRklvVERpT85Ne0UGB+hycMBD4WMlwwuLA1C8/Ih6kVYTyt1yx+U9mRWgzJVWIsaBY/8 8z98RmtA28QIWQ9Wnp6VR3ugF/aGIwB+YEZd3gMP9X9xMcbXfF7gfLcAQdNxmfuHjN1H SSHA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=zZ4ymocB12gj0tduN0d1jr/vmBKot0zf0VYWHsW//Zg=; b=JhgSYoDbK7Oia7+pnOf9df3+lK9K7qZrUY2EpRh6CwkSz5ztjuQJmzgwiuqDQWAo9u q+eCvTGpU+sYCWYovunjpX69oZJtEjXeWKkIkJmesGC8kqb0e11tXebVub92leo2B9Bw NznZ5QRsOaaecoxVakz9bm0E4RVvlWGjdiha7iQHZdD0eHUJ9YF8xpUOYrFuV61W+8qE DlPhI9E/4RSQZZ5ecQ62TatySWMHjt3vr+cP2kC0pa2gULdjgDfz2+QWrGRyGQYP8zSZ o8HZCp0SF7bQ/1NZmsN4DX87QljLy2jhpWc3FjID8j3K9Cut/8RYtTq1AYKgmODRdRb2 52ig== X-Gm-Message-State: AOAM532iqcpBKOdjqKxf+k8qF3fBGe1upUOZBRFkWvBTCT8wW3NbLdZt izzZSj3Vq6nrufi9nudZ0T3kp14/X+rDtpcggjkG4Q== X-Google-Smtp-Source: ABdhPJy6xawQGTQk6IsCbwu1/g98G3lPba6BhPjUDpiPkB0J9oiJA7riL617c5J1EalHnk0yBbjfIGvHkIG4jRJHSEA= X-Received: by 2002:a25:bd81:: with SMTP id f1mr35841847ybh.454.1590392017774; Mon, 25 May 2020 00:33:37 -0700 (PDT) MIME-Version: 1.0 References: <135fccacd4ee8a1ffe0e06f6f95c22e05dadf04a.camel@linuxfoundation.org> <20200415152105.GA11838@linux-uys3> In-Reply-To: From: "Nicolas Dechesne" Date: Mon, 25 May 2020 09:33:26 +0200 Message-ID: Subject: Re: [docs] Possible changes to the project docs To: Mark Morton Cc: "docs@lists.yoctoproject.org" Content-Type: multipart/alternative; boundary="00000000000046084705a673ffc9" --00000000000046084705a673ffc9 Content-Type: text/plain; charset="UTF-8" hi Mark, On Thu, May 21, 2020 at 10:42 PM Mark Morton wrote: > Hi: > > I'd like to actually start planning this conversion to Sphinx. So far > myself, Rob D., Nicolas, and Tim O. are all interested in helping out. > > I'd like to have a Zoom meeting or something similar to get started on > where to go from Nico's proof of concept. Please let me know if you want to > attend - I'm thinking sometime early next week. > Thanks for starting this. I will be happy to help. I can prepare an 'initial' plan to get us started. > > Thanks, > -Mark M. > > > -----Original Message----- > > From: docs@lists.yoctoproject.org On > Behalf > > Of Robert P. J. Day > > Sent: Thursday, April 16, 2020 11:06 AM > > To: docs@lists.yoctoproject.org > > Subject: Re: [docs] Possible changes to the project docs > > > > On Thu, 16 Apr 2020, Nicolas Dechesne wrote: > > > > > > > > > > > On Thu, Apr 16, 2020 at 7:46 PM Robert P. J. Day < > rpjday@crashcourse.ca> > > wrote: > > > On Thu, 16 Apr 2020, Nicolas Dechesne wrote: > > > > > > > As I put in one of my emails before you can use my dev branch: > > > > > > > > > https://git.linaro.org/people/nicolas.dechesne/poky.git/log/?h=sphinx > > > > > > > > then it's just > > > > pip3 install sphinx > > > > # to use the non default theme > > > > pip3 install sphinx_rtd_theme > > > > > > > > cd documentation make html > > > > > > > > and it should generate exactly that on your local folder > > > > https://people.linaro.org/~nicolas.dechesne/yp-docs/ > > > > > > > > I am happy to take patches in this branch (or create/maintain a > > > > contrib branch if more folks want to play/experiment and send > > > > patches). > > > > > > definitely need some mechanism to handle docbook entities and > basic > > > tags like ... i'm still poring over pandoc, can it be > > > configured to deal with that? > > > > > > will go read more ... > > > > > > > > > It does 'most of the time'. See: > > > https://people.linaro.org/~nicolas.dechesne/yp-docs/bsp-guide/bsp.xml. > > > html#bsp-layers > > > > > > where the docbook source is: > > > Each repository is a BSP layer supported by the Yocto Project > > > > > > > > > (e.g. meta-raspberrypi and > > > > > > > > > meta-intel). > > > > > > > > > I am not sure if it always does the *right* thing though.. and I have > > > seen occurrences where it failed. I am wondering if we should 'fix' > > > pandoc , or just spend some time fixing the output of pandoc. > > > I don't think we will avoid reading/checking each manual, anyways.. > > > I was thinking we could use pandoc for 80% of the work, some regex for > > > 15% and then manually finish the work.. it might be a bit optimistic > > > ;) > > > > interesting ... if you go to the top-level page: > > > > https://people.linaro.org/~nicolas.dechesne/yp-docs/bsp-guide/bsp- > > guide.xml.html > > > > the tag in the third note is *not* migrated over, you can > still see > > the tag. i suspect there will be plenty of tweaking, but i'm still > totally on-board > > with this, and am willing to contribute. > > > > rday > > --00000000000046084705a673ffc9 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
hi Mark,


On Thu,= May 21, 2020 at 10:42 PM Mark Morton <Mark.Morton@windriver.com> wrote:
Hi:

I'd like to actually start planning this conversion to Sphinx. So far = myself, Rob D., Nicolas, and Tim O. are all interested in helping out.

I'd like to have a Zoom meeting or something similar to get started on= where to go from Nico's proof of concept. Please let me know if you wa= nt to attend - I'm thinking sometime early next week.
<= div>
Thanks for starting this. I will be happy to help. I can= prepare an 'initial' plan to get us started.=C2=A0
=C2= =A0

Thanks,
-Mark M.

> -----Original Message-----
> From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf > Of Robert P. J. Day
> Sent: Thursday, April 16, 2020 11:06 AM
> To: = docs@lists.yoctoproject.org
> Subject: Re: [docs] Possible changes to the project docs
>
> On Thu, 16 Apr 2020, Nicolas Dechesne wrote:
>
> >
> >
> > On Thu, Apr 16, 2020 at 7:46 PM Robert P. J. Day <rpjday@crashcourse.ca&g= t;
> wrote:
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0On Thu, 16 Apr 2020, Nicolas Dechesne = wrote:
> >
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> As I put in one of my emails befo= re you can use my dev branch:
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0>
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> https://git.linaro.org/people/nicolas.dechesne/poky.git/log/?h= = =3Dsphinx
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0>
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> then it's just
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> pip3 install sphinx
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> # to use the non default theme > >=C2=A0 =C2=A0 =C2=A0 =C2=A0> pip3 install sphinx_rtd_theme
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0>
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> cd documentation make html
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0>
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> and it should generate exactly th= at on your local folder
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> https:= //people.linaro.org/~nicolas.dechesne/yp-docs/
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0>
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> I am happy to take patches in thi= s branch (or create/maintain a
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> contrib branch if more folks want= to play/experiment and send
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0> patches).
> >
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0=C2=A0 definitely need some mechanism = to handle docbook entities and basic
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0tags like <filename> ... i'm= still poring over pandoc, can it be
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0configured to deal with that?
> >
> >=C2=A0 =C2=A0 =C2=A0 =C2=A0=C2=A0 will go read more ...
> >
> >
> > It does 'most of the time'. See:
> > https://people.linar= o.org/~nicolas.dechesne/yp-docs/bsp-guide/bsp.xml.
> > html#bsp-layers
> >
> > where the docbook source is:
> > =C2=A0 =C2=A0 =C2=A0=C2=A0 Each repository is a BSP layer suppor= ted by the Yocto Project
> >
> >
> > =C2=A0 =C2=A0 =C2=A0 =C2=A0 (e.g. <filename>meta-raspberry= pi</filename> and
> >
> >
> > =C2=A0 =C2=A0 =C2=A0 =C2=A0 <filename>meta-intel</filen= ame>).
> >
> >
> > =C2=A0I am not sure if it always does the *right* thing though..= and I have
> > seen occurrences where it failed. I am wondering if we should &#= 39;fix'
> > pandoc , or just spend some time fixing the output of pandoc. > > I don't think we will avoid reading/checking each manual, an= yways..
> > I was thinking we could use pandoc for 80% of the work, some reg= ex for
> > 15% and then manually finish the work.. it might be a bit optimi= stic
> > ;)
>
>=C2=A0 =C2=A0interesting ... if you go to the top-level page:
>
> https://people.linaro.org/~n= icolas.dechesne/yp-docs/bsp-guide/bsp-
> guide.xml.html
>
> the <filename> tag in the third note is *not* migrated over, yo= u can still see
> the tag. i suspect there will be plenty of tweaking, but i'm stil= l totally on-board
> with this, and am willing to contribute.
>
> rday

--00000000000046084705a673ffc9--