瀏覽代碼

doc-rst: make dev-tools folder buildable stand-alone

Add minimal conf.py and moved dev-tools/tools.rst to dev-tools/index.rst
makes the dev-tools folder buildable stand-alone. To build only this
folder run::

  make SPHINXDIRS=dev-tools htmldocs
  make SPHINXDIRS=dev-tools pdfdocs

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Markus Heiser 8 年之前
父節點
當前提交
c289312f96
共有 3 個文件被更改,包括 19 次插入1 次删除
  1. 10 0
      Documentation/dev-tools/conf.py
  2. 8 0
      Documentation/dev-tools/index.rst
  3. 1 1
      Documentation/index.rst

+ 10 - 0
Documentation/dev-tools/conf.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8; mode: python -*-
+
+project = "Development tools for the kernel"
+
+tags.add("subproject")
+
+latex_documents = [
+    ('index', 'dev-tools.tex', project,
+     'The kernel development community', 'manual'),
+]

+ 8 - 0
Documentation/dev-tools/tools.rst → Documentation/dev-tools/index.rst

@@ -23,3 +23,11 @@ whole; patches welcome!
    kmemleak
    kmemcheck
    gdb-kernel-debugging
+
+
+.. only::  subproject and html
+
+   Indices
+   =======
+
+   * :ref:`genindex`

+ 1 - 1
Documentation/index.rst

@@ -14,7 +14,7 @@ Contents:
    admin-guide/index
    kernel-documentation
    process/index
-   dev-tools/tools
+   dev-tools/index
    driver-api/index
    media/index
    gpu/index