|
|
Subscribe / Log in / New account

Kernel documentation with Sphinx, part 1: how we got here

Kernel documentation with Sphinx, part 1: how we got here

[Kernel] Posted Jul 6, 2016 3:13 UTC (Wed) by jani

The last time LWN looked at formatted kernel documentation in January, it seemed like the merging of AsciiDoc support for the kernel's structured source-code documentation ("kernel-doc") comments, was imminent. As Jonathan Corbet, in the capacity of the kernel documentation maintainer, wrote: "A good-enough solution that exists now should not be held up overly long in the hopes that vague ideas for something else might turn into real, working code." Sometimes, however, the threat that something not quite perfect might be merged is enough to motivate people to turn those vague ideas into something real.

Subscribers can click below to see the full story by guest author (and the developer behind most of the Sphinx work) Jani Nikula.

Full Story (comments: 8)


Copyright © 2016, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds