.. -*- coding: utf-8; mode: rst -*-
.. include:: refs.txt

.. _install_linuxdoc:

================
Install LinuxDoc
================

Install bleeding edge.::

  pip install [--user] git+http://github.com/return42/linuxdoc.git

As the LinuxDoc lib evolving constantly, an update should be carried out
regularly.::

  pip install --upgrade git+http://github.com/return42/linuxdoc.git

If you are a developer and like to contribute to the LinuxDoc lib, fork on
github or clone and make a developer install::

  git clone https://github.com/return42/linuxdoc
  cd linuxdoc
  make install

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:

.. code-block:: python

    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.
      ]