Install LinuxDocΒΆ
Install / update from pypi.org:
python -m pip install -U linuxdoc
Alternative method: install bleeding edge into user site-packages:
python -m pip install -U --user git+http://github.com/return42/linuxdoc.git
Below you see how to integrate the LinuxDoc sphinx extensions into your sphinx
build process. In the conf.py (sphinx config) add the LinuxDoc
extensions:
extensions = [
"linuxdoc.rstFlatTable", # Implementation of the "flat-table" reST-directive.
"linuxdoc.rstKernelDoc", # Implementation of the "kernel-doc" reST-directive.
"linuxdoc.kernel_include", # Implementation of the "kernel-include" reST-directive.
"linuxdoc.manKernelDoc", # Implementation of the "kernel-doc-man" builder
"linuxdoc.cdomain", # Replacement for the sphinx c-domain.
"linuxdoc.kfigure", # Sphinx extension which implements scalable image handling.
]