[PATCH v2 1/4] doc-rst: make dev-tools folder buildable stand-alone

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxxx>
---
 Documentation/dev-tools/conf.py                  | 10 ++++++++++
 Documentation/dev-tools/{tools.rst => index.rst} |  8 ++++++++
 Documentation/index.rst                          |  2 +-
 3 files changed, 19 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/dev-tools/conf.py
 rename Documentation/dev-tools/{tools.rst => index.rst} (87%)

diff --git a/Documentation/dev-tools/conf.py b/Documentation/dev-tools/conf.py
new file mode 100644
index 0000000..7faafa3
--- /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/tools.rst b/Documentation/dev-tools/index.rst
similarity index 87%
rename from Documentation/dev-tools/tools.rst
rename to Documentation/dev-tools/index.rst
index 824ae8e..07d8811 100644
--- a/Documentation/dev-tools/tools.rst
+++ b/Documentation/dev-tools/index.rst
@@ -23,3 +23,11 @@ whole; patches welcome!
    kmemleak
    kmemcheck
    gdb-kernel-debugging
+
+
+.. only::  subproject and html
+
+   Indices
+   =======
+
+   * :ref:`genindex`
diff --git a/Documentation/index.rst b/Documentation/index.rst
index f6a3d47..0f98823 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
-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux