LinuxDoc¶
The LinuxDoc library contains:
- kernel-doc
A “C” friendly markup, the parser, the Sphinx-doc extension and some tools. The kernel-doc markup embeds documentation within the C source files, using a few simple conventions. The parser grabs the documentation from source and generates proper reST [ref].
The parser is written in Python and its API is used by the corresponding Sphinx-doc extension. Command line tools shipped with:
linuxdoc.autodoc: Suitable for automatic API documentation
linuxdoc.lintdoc: Lint kernel-doc comments from source code.
linuxdoc.rest: A command line interface for kernel-doc’s parser API.
- kernel-doc-man
A man page builder. An extension/replacement of the common Sphinx-doc man builder also integrated in the kernel-doc Sphinx-doc extension.
- flat-table
A diff and author friendly list-table replacement with column-span, row-span and auto-span [ref].
- cdomain
A customized Sphinx’s C Domain extension. Suitable for demanding projects.
- Scalable figure and image handling
Sphinx extension which implements scalable image handling. Simplifies image handling from the author’s POV. Wins where Sphinx-doc image handling fails. Whatever graphic tools available on your build host, you always get the best output-format. Graphviz’s DOT format included.
- kernel-include
A replacement for the
includereST directive. The directive expand environment variables in the path name and allows to include files from arbitrary locations.
About “LinuxDoc”
Even if this project started in context of the Linux-Kernel documentation (where the name comes from), you can use these extensions in common sphinx-doc projects. If this is unclear to you, take a look at our Introduction.
Table of Contents¶
LinuxDoc is hosted at github: https://github.com/return42/linuxdoc