|
|
Subscribe / Log in / New account

Kernel documentation with Sphinx, part 2: how it works

Kernel documentation with Sphinx, part 2: how it works

Posted Aug 5, 2016 13:26 UTC (Fri) by return42 (guest, #110388)
Parent article: Kernel documentation with Sphinx, part 2: how it works

Jani mentioned that I worked on some more advanced conversion scripts. Now I
separated this work in a project. To install the project visit:

https://return42.github.io/dbxml2rst/

I'am also continuous working on my POC, testing all my developments and thoughts.

http://return42.github.io/sphkerneldoc/

There you will find a conversion of all DocBooks and a full scan of the kernel
source tree. The scan gather all kernel-doc comments and builds a analogous tree
of reST files with the documentation from the source-code comments. The HTML
of this is here:

http://return42.github.io/sphkerneldoc/linux_src_doc/inde...

All this is based on a set of Sphinx-extensions from my POC, available from my
*linuxdoc* project:

https://return42.github.io/linuxdoc

Within the *linuxdoc* project, you will find the python version of the
kernel-doc parser (Jani mentioned), which runs directly in the Sphinx
process. For me, the decision to reimplementing the kernel-doc perl script in
python was not easy. But within my POC I came to the point where I thought, that
adapting the perl script was at its end. E.g. scanning a file only one time not
on every kernel-doc directive and implementing stuff like a kernel-doc lint is
more straight forward with the python version.

-- Markus --


to post comments


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