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

.. _linuxdoc:

========
LinuxDoc
========

.. sidebar::  WIP :py:mod:`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 :ref:`customized-c-domain` has been
   migrated right now (some are obsolete since V3.1).

.. _C, initial rewrite:   https://github.com/sphinx-doc/sphinx/commit/0f49e30c51b5cc5055cda5b4b294c2dd9d1df573#r38750737
.. _Sphinx-doc PR-8313: https://github.com/sphinx-doc/sphinx/pull/8313

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 :ref:`Introduction <kernel-doc-intro>`.

.. toctree::
   :maxdepth: 3

   Introduction <kernel-doc-intro>
   install
   linuxdoc-howto/index
   cmd-line
   kernel_dev_remarks
   linux

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

Source Code
===========

.. toctree::
   :maxdepth: 2

   linuxdoc-api/linuxdoc


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`