From c289312f964b6e8851d0812b65f59c8b0387e78d Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 26 Oct 2016 08:23:14 +0200 Subject: 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 Signed-off-by: Jonathan Corbet --- Documentation/dev-tools/conf.py | 10 ++++++++++ Documentation/dev-tools/index.rst | 33 +++++++++++++++++++++++++++++++++ Documentation/dev-tools/tools.rst | 25 ------------------------- Documentation/index.rst | 2 +- 4 files changed, 44 insertions(+), 26 deletions(-) create mode 100644 Documentation/dev-tools/conf.py create mode 100644 Documentation/dev-tools/index.rst delete mode 100644 Documentation/dev-tools/tools.rst (limited to 'Documentation') diff --git a/Documentation/dev-tools/conf.py b/Documentation/dev-tools/conf.py new file mode 100644 index 000000000000..7faafa3f7888 --- /dev/null +++ b/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'), +] diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst new file mode 100644 index 000000000000..07d881147ef3 --- /dev/null +++ b/Documentation/dev-tools/index.rst @@ -0,0 +1,33 @@ +================================ +Development tools for the kernel +================================ + +This document is a collection of documents about development tools that can +be used to work on the kernel. For now, the documents have been pulled +together without any significant effot to integrate them into a coherent +whole; patches welcome! + +.. class:: toc-title + + Table of contents + +.. toctree:: + :maxdepth: 2 + + coccinelle + sparse + kcov + gcov + kasan + ubsan + kmemleak + kmemcheck + gdb-kernel-debugging + + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` diff --git a/Documentation/dev-tools/tools.rst b/Documentation/dev-tools/tools.rst deleted file mode 100644 index 824ae8e54dd5..000000000000 --- a/Documentation/dev-tools/tools.rst +++ /dev/null @@ -1,25 +0,0 @@ -================================ -Development tools for the kernel -================================ - -This document is a collection of documents about development tools that can -be used to work on the kernel. For now, the documents have been pulled -together without any significant effot to integrate them into a coherent -whole; patches welcome! - -.. class:: toc-title - - Table of contents - -.. toctree:: - :maxdepth: 2 - - coccinelle - sparse - kcov - gcov - kasan - ubsan - kmemleak - kmemcheck - gdb-kernel-debugging diff --git a/Documentation/index.rst b/Documentation/index.rst index f6a3d4766495..0f98823126f2 100644 --- a/Documentation/index.rst +++ b/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 -- cgit v1.2.3-55-g7522