[coreboot] Adapting Linux kernel documentation setup with Sphinx and reStructuredText
bernardlprf at openmailbox.org
Wed Oct 12 03:59:55 CEST 2016
Hello I don't want to be a party pooper but gohugo uses non-free
from cloudflare (fortunately part of the site is ok).
Le 03/10/2016 21:43, Martin Roth a écrit :
> Zaolin has been working for a while on updating our documentation, and his
> plan is to switch coreboot to using Hugo for our documentation manager.
> Hugo supports various different markup languages, including markdown,
> html, RestructuredText, and AsciiDoc. 
> I meant to send the list an email a while back about doing this, but got
> sidetracked with other projects. It's just been picked back up, so if
> anyone has any thoughts, please feel free to comment, either here or in his
> patches.  
> We're going to try to switch away from the wiki for our documentation. The
> wiki is great for some things, but not so good for other things. The
> thought is that if we keep the documentation in the coreboot tree, in an
> accessible format, people will be able to contribute to it more easily, and
> it will hopefully stay more up-to-date. The plan is to move some of the
> documentation out of the wiki into the Documentation folder and adding new
> documentation shortly.
> And, as always, any documentation contributions would be greatly
> appreciated. 
>  https://gohugo.io/
>  https://gohugo.io/content/supported-formats
>  https://review.coreboot.org/#/c/16853/
>  https://review.coreboot.org/#/c/16787/
>  Please.
> On Mon, Oct 3, 2016 at 1:56 AM, Paul Menzel via coreboot <
> coreboot at coreboot.org> wrote:
>> Dear coreboot folks,
>> The Linux kernel switched to Sphinx and reStructuredText  for its
>> documentation .
>> Would it make sense to also use that for coreboot? I would see the
>> following benefits.
>> 1. It’s easier to import code like drivers from the Linux kernel to
>> 2. Developers familiar with the Linux kernel have it easier to work on
>> 3. The coreboot project could import all improvements the Linux kernel
>> documenation gets.
>>  https://en.wikipedia.org/wiki/ReStructuredText
>>  https://static.lwn.net/kerneldoc/index.html
>>  https://lwn.net/Articles/692704/
>> "Kernel documentation with Sphinx, part 1: how we got here"
>>  https://lwn.net/Articles/692705/
>> "Kernel documentation with Sphinx, part 2: how it works
>> coreboot mailing list: coreboot at coreboot.org
Note: veuillez s'il vous plaît utiliser GnuPg pour nos futures conversations
Plus d'info ici:
Message envoyé avec GNU Icedove un fork de Thunderbird
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 836 bytes
Desc: OpenPGP digital signature
More information about the coreboot