LinuxDoc

WIP linuxdoc.cdomain

Sphinx v3.0 and above includes a C, initial rewrite which is not downward compatible and the Sphinx C-Domain is still WIP (Sphinx-doc PR-8313). Therefore not all the features of Customized sphinx c-domain has been migrated right now (some are obsolete since V3.1).

The LinuxDoc library contains sphinx-doc extensions and command line tools to extract documentation from C/C++ source file comments. 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.

• Introduction
  • by example
  • LinuxDoc feature overview
• Install LinuxDoc
• LinuxDoc HowTo
  • kernel-doc
    • kernel-doc syntax
    • kernel-doc in reST documents
    • Examples & Tests
    • parsing modes
  • other topics
    • Scalable figure and image handling
    • About tables
    • Customized sphinx c-domain
    • man pages from kernel-doc comments
    • Use kernel-include in reST documents
• Command line tools
  • linuxdoc.rest
  • linuxdoc.lintdoc
  • linuxdoc.autodoc
• Remarks for Kernel developer
• Patch Linux Kernel Documentation
  • Discussion

LinuxDoc is hosted at github: https://github.com/return42/linuxdoc

Source Code

• linuxdoc package
  • Submodules
  • Module contents

Indices and tables

• Index

• Module Index